Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W 

A

ACCEPTED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
AccessException - Exception in com.pingidentity.pa.sdk.policy
An Exception thrown by an Interceptor to indicate a transaction should not proceed.
AccessException(String, HttpStatus, Throwable) - Constructor for exception com.pingidentity.pa.sdk.policy.AccessException
Constructs a new AccessException.
AccessException(String, HttpStatus) - Constructor for exception com.pingidentity.pa.sdk.policy.AccessException
Constructs a new AccessException.
AccessException(AccessExceptionContext) - Constructor for exception com.pingidentity.pa.sdk.policy.AccessException
Constructs a new AccessException from an AccessExceptionContext.
AccessExceptionContext - Class in com.pingidentity.pa.sdk.policy
Context data builder used to create an AccessException.
ACL - Static variable in class com.pingidentity.pa.sdk.http.Method
 
add(HeaderName, String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Add a HeaderField to this Headers object.
add(String, String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Add a HeaderField to this Headers object.
addAll(Collection<ConfigurationField>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds a collection of ConfigurationFields
advanced() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the advanced flag on the last set ConfigurationField to true
advanced(boolean) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the advanced flag on the last set ConfigurationField
ALLOWED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
Application - Interface in com.pingidentity.pa.sdk.policy
Applications represent the protected web applications and APIs to which client requests are sent.
APPLICATION_FORM_URL - Static variable in class com.pingidentity.pa.sdk.http.CommonMediaTypes
MediaType for application/x-www-form-urlencoded, using the UTF-8 Charset
APPLICATION_SOAP - Static variable in class com.pingidentity.pa.sdk.http.CommonMediaTypes
MediaType for application/soap+xml, using the UTF-8 Charset
ApplicationType - Enum in com.pingidentity.pa.sdk.policy
ApplicationType represents the type of Application
AsyncIdentityMappingPlugin<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.identitymapping
A AsyncIdentityMappingPlugin is the runtime instantiation of an Identity Mapping defined in the Administrative API that supports asynchronous computation.
AsyncIdentityMappingPluginBase<T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.identitymapping
A base class simplifying the implementation of AsyncIdentityMappingPlugin.
AsyncIdentityMappingPluginBase() - Constructor for class com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPluginBase
 
AsyncLoadBalancingHandler - Interface in com.pingidentity.pa.sdk.ha.lb
A AsyncLoadBalancingHandler is the runtime component of a LoadBalancingStrategy that provides the logic for load balancing requests to TargetHosts configured for a Site.
AsyncLoadBalancingPlugin<H extends AsyncLoadBalancingHandler,C extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.ha.lb
A AsyncLoadBalancingPlugin is the runtime instantiation of a Load Balancing Strategy, defined in the Administrative API, that supports asynchronous computation.
AsyncLoadBalancingPluginBase<H extends AsyncLoadBalancingHandler,C extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.ha.lb
A base class simplifying the implementation of AsyncLoadBalancingPlugin.
AsyncLoadBalancingPluginBase() - Constructor for class com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingPluginBase
 
AsyncRuleInterceptor<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.policy
A AsyncRuleInterceptor is the runtime instantiation of a Rule defined in the Administrative API that supports applying access control logic as an asynchronous computation.
AsyncRuleInterceptorBase<T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.policy
A base class simplifying the implementation of AsyncRuleInterceptor
AsyncRuleInterceptorBase() - Constructor for class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
AsyncSiteAuthenticatorInterceptor<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.siteauthenticator
A AsyncSiteAuthenticatorInterceptor is the runtime instantiation of a Site Authenticator defined in the Administrative API that supports asynchronous computation.
AsyncSiteAuthenticatorInterceptorBase<T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.siteauthenticator
A base class simplifying the implementation of AsyncSiteAuthenticatorInterceptor.
AsyncSiteAuthenticatorInterceptorBase() - Constructor for class com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptorBase
 
ATTRIBUTE_ERROR - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ATTRIBUTE_ERROR_DESCRIPTION - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ATTRIBUTE_ERROR_URI - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ATTRIBUTE_REALM - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ATTRIBUTE_SCOPE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
AttributeHeaderPair - Class in com.pingidentity.pa.sdk.identitymapping.header
Describes a mapping between a user attribute and a header name to be used to return the value to a target Site.
AttributeHeaderPair(String, String, boolean) - Constructor for class com.pingidentity.pa.sdk.identitymapping.header.AttributeHeaderPair
Constructor that sets the attribute name, header name, and a flag to indicate that this mapping represents the subject.
AUTHENTICATION_SCHEME_BEARER - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 

B

BAD_GATEWAY - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
BAD_REQUEST - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
badRequest() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "400 Bad Request" status.
badRequestJson(String) - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "400 Bad Request" status, a Content-Type of "application/json;charset=utf-8", and the provided body content.
BASELINE_CONTROL - Static variable in class com.pingidentity.pa.sdk.http.Method
 
BasicLocalizedMessage - Class in com.pingidentity.pa.sdk.localization
A simple LocalizedMessage that resolves a single message key.
BasicLocalizedMessage(String) - Constructor for class com.pingidentity.pa.sdk.localization.BasicLocalizedMessage
Constructs a new BasicLocalizedMessage from a localized message key.
BIND - Static variable in class com.pingidentity.pa.sdk.http.Method
 
Body - Interface in com.pingidentity.pa.sdk.http
A representation of the body content of an HTTP message.
body(String, Charset) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Sets the Response body with the provided message, encoding as bytes using the provided Charset and updating the Content-Length header appropriately.
body(String) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Sets the Response body with the provided message using UTF-8 encoding and updating the Content-Length header appropriately.
body(byte[]) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Sets the Response body with the provided message using UTF-8 encoding and updating the Content-Length header appropriately.
BodyFactory - Interface in com.pingidentity.pa.sdk.http
Factory for creating a Body instance.
bodyFactory() - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Helper method to provide an implementation of BodyFactory.
build() - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates the Response.
buttonGroup(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the button group on the last ConfigurationField

C

calculateTargetHost(Exchange, List<TargetHost>, List<TargetHost>) - Method in interface com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingHandler
Calculate the target host, given the list of available hosts and the current exchange.
calculateTargetHost(Exchange, List<TargetHost>, List<TargetHost>) - Method in interface com.pingidentity.pa.sdk.ha.lb.LoadBalancingHandler
Calculate the target host, given the list of available hosts and the current exchange.
calculateTargetHost(Exchange, List<TargetHost>, List<TargetHost>) - Method in class com.pingidentity.pa.sdk.ha.lb.LoadBalancingStrategy.NONE
 
cause(Throwable) - Method in class com.pingidentity.pa.sdk.policy.AccessExceptionContext
Sets the AccessException cause.
CHECKIN - Static variable in class com.pingidentity.pa.sdk.http.Method
 
CHECKOUT - Static variable in class com.pingidentity.pa.sdk.http.Method
 
clear() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Clears the content of the ConfigurationBuilder
ClientRequest - Class in com.pingidentity.pa.sdk.http.client
Represents a HTTP request that can be sent to a HTTP server by a HttpClient.
ClientRequest(Method, String, Headers) - Constructor for class com.pingidentity.pa.sdk.http.client.ClientRequest
Constructs a ClientRequest representing a HTTP request without a body.
ClientRequest(Method, String, Headers, byte[]) - Constructor for class com.pingidentity.pa.sdk.http.client.ClientRequest
Constructs a ClientRequest representing a HTTP request with a body.
ClientResponse - Interface in com.pingidentity.pa.sdk.http.client
Represents an HTTP response returned by an outbound HTTP call made by a HttpClient instance.
com.pingidentity.pa.sdk.accessor - package com.pingidentity.pa.sdk.accessor
 
com.pingidentity.pa.sdk.accessor.certgroup - package com.pingidentity.pa.sdk.accessor.certgroup
 
com.pingidentity.pa.sdk.accessor.keypair - package com.pingidentity.pa.sdk.accessor.keypair
 
com.pingidentity.pa.sdk.accessor.tps - package com.pingidentity.pa.sdk.accessor.tps
 
com.pingidentity.pa.sdk.ha.lb - package com.pingidentity.pa.sdk.ha.lb
 
com.pingidentity.pa.sdk.http - package com.pingidentity.pa.sdk.http
 
com.pingidentity.pa.sdk.http.client - package com.pingidentity.pa.sdk.http.client
 
com.pingidentity.pa.sdk.identity - package com.pingidentity.pa.sdk.identity
 
com.pingidentity.pa.sdk.identitymapping - package com.pingidentity.pa.sdk.identitymapping
 
com.pingidentity.pa.sdk.identitymapping.header - package com.pingidentity.pa.sdk.identitymapping.header
 
com.pingidentity.pa.sdk.interceptor - package com.pingidentity.pa.sdk.interceptor
 
com.pingidentity.pa.sdk.localization - package com.pingidentity.pa.sdk.localization
 
com.pingidentity.pa.sdk.oauth - package com.pingidentity.pa.sdk.oauth
 
com.pingidentity.pa.sdk.plugins - package com.pingidentity.pa.sdk.plugins
The PingAccess Plugin Framework
com.pingidentity.pa.sdk.policy - package com.pingidentity.pa.sdk.policy
 
com.pingidentity.pa.sdk.policy.config - package com.pingidentity.pa.sdk.policy.config
 
com.pingidentity.pa.sdk.policy.error - package com.pingidentity.pa.sdk.policy.error
This package provides the following implementations of ErrorHandlingCallback: LocalizedInternalServerErrorCallback returns an HTTP 500 Internal Server Error.
com.pingidentity.pa.sdk.services - package com.pingidentity.pa.sdk.services
 
com.pingidentity.pa.sdk.siteauthenticator - package com.pingidentity.pa.sdk.siteauthenticator
 
com.pingidentity.pa.sdk.ssl - package com.pingidentity.pa.sdk.ssl
 
com.pingidentity.pa.sdk.ui - package com.pingidentity.pa.sdk.ui
 
com.pingidentity.pa.sdk.util - package com.pingidentity.pa.sdk.util
 
com.pingidentity.sdk.key - package com.pingidentity.sdk.key
 
CommonMediaTypes - Class in com.pingidentity.pa.sdk.http
Constants for common MediaTypes.
ConfigurablePlugin<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.plugins
Interface to allow plugins to receive configuration information from the UI/Administrative API.
ConfigurationBuilder - Class in com.pingidentity.pa.sdk.ui
Creates an ordered set of ConfigurationField.
ConfigurationBuilder() - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Constructor for the ConfigurationBuilder.
ConfigurationBuilder(Set<ConfigurationField>) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Constructor for the ConfigurationBuilder.
ConfigurationDependentFieldOption - Class in com.pingidentity.pa.sdk.ui
An immutable type used to represent the possible dependant field options for a configurable UI type.
ConfigurationDependentFieldOption(String, List<ConfigurationOption>) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationDependentFieldOption
 
ConfigurationDependentFieldOption(DependentFieldOption) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationDependentFieldOption
 
configurationField(String, String, ConfigurationType, Set<ConfigurationOption>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds an individual ConfigurationField (used for multivalued fieldTypes, as it provides configuration options)
configurationField(String, String, ConfigurationType) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds an individual ConfigurationField
configurationField(ConfigurationField) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds an individual ConfigurationField
ConfigurationField - Class in com.pingidentity.pa.sdk.ui
 
ConfigurationField(ConfigurationField) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationField
 
ConfigurationField(String, String, ConfigurationType) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationField
 
ConfigurationField(String, String, ConfigurationType, Collection<ConfigurationOption>) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationField
 
ConfigurationField.Help - Class in com.pingidentity.pa.sdk.ui
 
ConfigurationModelAccessor<T> - Interface in com.pingidentity.pa.sdk.accessor
ConfigurationModelAccessors provide access to PingAccess administrative configuration from plugins.
ConfigurationModelAccessorFactory - Interface in com.pingidentity.pa.sdk.accessor
The factory used to get ConfigurationModelAccessor instances.
configurationModelAccessorFactory() - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Helper method to provide an implementation of ConfigurationModelAccessorFactory
ConfigurationOption - Class in com.pingidentity.pa.sdk.ui
An immutable type used to represent the possible options for a configurable UI type.
ConfigurationOption(String, String) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationOption
Constructor
ConfigurationOption(String, String, String) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationOption
Constructor
ConfigurationParentField - Class in com.pingidentity.pa.sdk.ui
An immutable type used to represent a ConfigurationField that controls the valid values for other ConfigurationFields in the same PluginConfiguration.
ConfigurationParentField(String, List<ConfigurationDependentFieldOption>) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationParentField
 
ConfigurationParentField(ParentField) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationParentField
 
ConfigurationType - Enum in com.pingidentity.pa.sdk.ui
The type of a ConfigurationField
configure(C) - Method in class com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingPluginBase
 
configure(T) - Method in class com.pingidentity.pa.sdk.ha.lb.LoadBalancingPluginBase
Implementation of ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) that saves the provided configuration data in a field.
configure(T) - Method in class com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPluginBase
 
configure(P) - Method in class com.pingidentity.pa.sdk.identitymapping.header.HeaderIdentityMappingPlugin
 
configure(T) - Method in class com.pingidentity.pa.sdk.identitymapping.IdentityMappingPluginBase
Implementation of ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) that saves the provided configuration data in a field.
configure(T) - Method in interface com.pingidentity.pa.sdk.plugins.ConfigurablePlugin
This method is called to provide the configuration from the UI/Administrative API.
configure(T) - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
configure(T) - Method in class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
configure(T) - Method in class com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptorBase
 
configure(T) - Method in class com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptorBase
Implementation of ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) that saves the provided configuration data in a field.
CONFLICT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
CONNECT - Static variable in class com.pingidentity.pa.sdk.http.Method
 
contains(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Returns true if this Headers object contains a HeaderField with the specified name.
contentType(String) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Sets the Content-Type header field on the Response.
contentType(MediaType) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Sets the Content-Type header field on the Response.
CONTINUE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
COPY - Static variable in class com.pingidentity.pa.sdk.http.Method
 
create(String, String, Class<T>) - Static method in class com.pingidentity.pa.sdk.http.ExchangeProperty
Creates a new ExchangeProperty.
create() - Method in interface com.pingidentity.pa.sdk.http.HeadersFactory
Creates an empty Headers object.
create(List<HeaderField>) - Method in interface com.pingidentity.pa.sdk.http.HeadersFactory
Creates a Headers object from a List of HeaderFields.
create(String, boolean, boolean, boolean) - Static method in class com.pingidentity.pa.sdk.http.Method
Constructs a new Method This constructor is only required to create Method instances that are not defined in Method.
create(HttpStatus) - Static method in class com.pingidentity.pa.sdk.policy.AccessExceptionContext
Creates a new AccessExceptionContext with a specific HTTP response status.
CREATED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
createEmptyBody() - Method in interface com.pingidentity.pa.sdk.http.BodyFactory
Create a Body that contains no content
createHeaders() - Static method in class com.pingidentity.pa.sdk.http.client.ClientRequest
A helper method to create a Headers instance.
createInMemoryBody(byte[]) - Method in interface com.pingidentity.pa.sdk.http.BodyFactory
Create a Body from the specified byte array
createWwwAuthenticateErrorHeaderValue(String, Set<String>, String, String, String) - Static method in class com.pingidentity.pa.sdk.oauth.OAuthUtilities
Returns the header value for the WWW-Authenticate header defined in RFC6750.
createWwwAuthenticateErrorHeaderValue(Exchange, Set<String>, String, String, String) - Static method in class com.pingidentity.pa.sdk.oauth.OAuthUtilities
Returns the header value for the WWW-Authenticate header defined in RFC6750.

D

decrypt(byte[]) - Method in interface com.pingidentity.sdk.key.MasterKeyEncryptor
Decrypts the master key's cipher text.
defaultValue(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the defaultValue on the last set ConfigurationField.
DELETE - Static variable in class com.pingidentity.pa.sdk.http.Method
 
DependantFieldAccessor - Interface in com.pingidentity.pa.sdk.accessor
A DependantFieldAccessor allows a plugin to indicate the values that are valid for one of its ConfigurationField, based on the value of another of its ConfigurationFields.
DependantFieldAccessorFactory - Interface in com.pingidentity.pa.sdk.accessor
The factory used to get DependantFieldAccessor instances.
DependentFieldOption - Annotation Type in com.pingidentity.pa.sdk.ui
The annotation used to define dependent field options when using UIElement
dependentOptions() - Method in interface com.pingidentity.pa.sdk.accessor.DependantFieldAccessor
Method for acquiring the List of ConfigurationDependentFieldOptions to be exposed in the plugin's descriptor in the Administrative API.
dependentOptions() - Method in class com.pingidentity.pa.sdk.ui.ParentField.NONE
 
DescribesUIConfigurable - Interface in com.pingidentity.pa.sdk.plugins
An interface for describing the expected schema for a plugin's configuration, for use by the Administrative API and UI.
deselectable() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Allows a radio button to be deselected for the last ConfigurationField
deselectable(boolean) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Allows or denies a radio button from being deselected for the last ConfigurationField
domain(String) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the domain
DynamicConfigurationParentField - Class in com.pingidentity.pa.sdk.ui
DynamicConfigurationParentField(String, Class<? extends DependantFieldAccessor>) - Constructor for class com.pingidentity.pa.sdk.ui.DynamicConfigurationParentField
 
DynamicConfigurationParentField(ParentField) - Constructor for class com.pingidentity.pa.sdk.ui.DynamicConfigurationParentField
 
dynamicOptions(Class<? extends ConfigurationModelAccessor>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Replaces the last ConfigurationField with a DynamicOptionsConfigurationField and applies the provided ConfigurationModelAccessor class to be used by the DynamicOptionsConfigurationField.
DynamicOptionsConfigurationField - Class in com.pingidentity.pa.sdk.ui
DynamicOptionsConfigurationField(ConfigurationField, Class<? extends ConfigurationModelAccessor>) - Constructor for class com.pingidentity.pa.sdk.ui.DynamicOptionsConfigurationField
 
DynamicOptionsConfigurationField(String, String, ConfigurationType, Class<? extends ConfigurationModelAccessor>) - Constructor for class com.pingidentity.pa.sdk.ui.DynamicOptionsConfigurationField
 

E

encrypt(byte[]) - Method in interface com.pingidentity.sdk.key.MasterKeyEncryptor
Encrypts the data that will eventually be stored in the master key file.
EntityScopedHandlerPlugin<H,C extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.plugins
A ConfigurablePlugin that provides methods to create a runtime handler scoped to a specific configuration entity such as a Site.
equals(Object) - Method in class com.pingidentity.pa.sdk.accessor.certgroup.TrustedCertificateGroupModel
 
equals(Object) - Method in class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
 
equals(Object) - Method in class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
 
equals(Object) - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
Two ClientRequest instances are considered equal if their serialized representations are equal.
equals(Object) - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
Indicates whether some other object is "equal to" this property.
equals(Object) - Method in class com.pingidentity.pa.sdk.http.HeaderField
Two HeaderFields are equal when their HeaderNames are equal and their values are equal.
equals(String) - Method in class com.pingidentity.pa.sdk.http.HeaderName
 
equals(Object) - Method in class com.pingidentity.pa.sdk.http.HeaderName
 
equals(Object) - Method in class com.pingidentity.pa.sdk.http.HttpStatus
Determines if this status equals another [object].
equals(Object) - Method in class com.pingidentity.pa.sdk.http.MediaType
Two MediaTypes are considered equal if their baseType and parameters fields are equal.
equals(Object) - Method in class com.pingidentity.pa.sdk.http.Method
Two Method objects are considered equal when their names are equal using a case-sensitive comparison.
equals(Object) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Two SetCookie objects are equal if their SetCookie.toString() representations are equal
equals(Object) - Method in class com.pingidentity.pa.sdk.identitymapping.header.AttributeHeaderPair
An AttributeHeaderPair is considered equal to another AttributeHeaderPair if the attributeNames are equal (case sensitive) and the headerNames are equal (case insensitive).
ERROR_CODE_ACCESS_DENIED - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_INSUFFICIENT_SCOPE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_INVALID_CLIENT - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_INVALID_REQUEST - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_INVALID_SCOPE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_INVALID_TOKEN - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_SERVER_ERROR - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_TEMPORARILY_UNAVAILABLE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_UNAUTHORIZED_CLIENT - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_UNSUPPORTED_GRANT_TYPE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
ERROR_CODE_UNSUPPORTED_RESPONSE_TYPE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
errorCodeLabel - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
errorCodeName - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
errorContentTypeLabel - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
errorContentTypeName - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
ErrorDescription - Enum in com.pingidentity.pa.sdk.localization
Enum with descriptions for common errors
errorDescription(LocalizedMessage) - Method in class com.pingidentity.pa.sdk.policy.AccessExceptionContext
Sets the localized error description.
ErrorHandlerConfiguration - Interface in com.pingidentity.pa.sdk.policy.config
An interface that describes the configuration used by ErrorHandlerConfiguration
ErrorHandlerConfigurationImpl - Class in com.pingidentity.pa.sdk.policy.config
 
ErrorHandlerConfigurationImpl() - Constructor for class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
ErrorHandlerUtil - Class in com.pingidentity.pa.sdk.policy.config
 
ErrorHandlerUtil() - Constructor for class com.pingidentity.pa.sdk.policy.config.ErrorHandlerUtil
 
ErrorHandlingCallback - Interface in com.pingidentity.pa.sdk.policy
Some kinds of interceptors should not write their own responses, especially for error conditions.
ErrorInfo - Interface in com.pingidentity.pa.sdk.policy.error
Information about an error that is used to generate an HTTP response.
errorResponseCode - Variable in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
errorResponseContentType - Variable in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
errorResponseStatusMsg - Variable in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
errorResponseTemplateFile - Variable in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
errorRespStatusMsgLabel - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
errorRespStatusMsgName - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
errorTemplateFileLabel - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
errorTemplateFileName - Static variable in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
exceptionMessage(String) - Method in class com.pingidentity.pa.sdk.policy.AccessExceptionContext
Sets the AccessException message (for logging purposes).
Exchange - Interface in com.pingidentity.pa.sdk.http
The Exchange represents a request / response.
ExchangeProperty<T> - Class in com.pingidentity.pa.sdk.http
A strongly-typed key that can be used to get and set properties of an Exchange.
EXPECTATION_FAILED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
expired() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Expires the cookie
expiresAt(Instant) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the cookie's expiresAt value, overriding any set previously via SetCookie.expiresAtRawStr(String).
expiresAtRawStr(String) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the cookie's expiresAt value to the specified raw date/time string.

F

Factory() - Constructor for class com.pingidentity.pa.sdk.http.ResponseBuilder.Factory
 
FixedMessage - Class in com.pingidentity.pa.sdk.localization
An implementation of LocalizedMessage that just returns a fixed message string, without resolving any localized values.
FixedMessage(String) - Constructor for class com.pingidentity.pa.sdk.localization.FixedMessage
Creates a new FixedMessage from a message string.
FORBIDDEN - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
forbidden() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "403 Forbidden" status.
forCode(int) - Static method in class com.pingidentity.pa.sdk.http.HttpStatus
Retrieves the HttpStatus constant for a supplied status code.
forName(String) - Static method in class com.pingidentity.pa.sdk.http.Method
Retrieves the Method for the supplied name.
FOUND - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
found(String) - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "302 Found" status.
from(Class) - Static method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Factory method that builds a ConfigurationBuilder from a class by parsing the UIElement annotations.

G

GATEWAY_TIMEOUT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
get(String) - Method in interface com.pingidentity.pa.sdk.accessor.ConfigurationModelAccessor
Method for acquiring the configuration model using the field value from the configuration submitted to the Administrative API.
GET - Static variable in class com.pingidentity.pa.sdk.http.Method
 
get(String) - Method in class com.pingidentity.pa.sdk.ui.UIElement.NONE
 
getAccept() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Accept HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getAccessControlAllowCredentials() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Access-Control-Allow-Credentials HeaderField.
getAccessControlAllowHeaders() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Access-Control-Allow-Headers HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getAccessControlAllowMethods() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Access-Control-Allow-Methods HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getAccessControlAllowOrigin() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Access-Control-Allow-Origin HeaderField.
getAccessControlExposeHeaders() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Access-Control-Expose-Headers HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getAccessControlMaxAge() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Access-Control-Max-Age HeaderField.
getAccessControlRequestHeaders() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Access-Control-Request-Headers HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getAccessControlRequestMethod() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Access-Control-Request-Method HeaderField.
getAlias() - Method in class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
 
getApplication() - Method in interface com.pingidentity.pa.sdk.policy.PolicyConfiguration
Returns the Application configured for this policy configuration
getAttributeName() - Method in class com.pingidentity.pa.sdk.identitymapping.header.AttributeHeaderPair
Returns the attribute name
getAttributeNames() - Method in interface com.pingidentity.pa.sdk.identity.SessionStateSupport
Returns an unmodifiable Set of the session attribute name.
getAttributes() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the JSON representation of the identity attributes.
getAttributes() - Method in interface com.pingidentity.pa.sdk.identity.SessionStateSupport
Returns an unmodifiable Map containing the session attributes.
getAttributeValue(String) - Method in interface com.pingidentity.pa.sdk.identity.SessionStateSupport
Returns the attribute value for the given name or null if not present.
getAuthorization() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Authorization HeaderField.
getBaseType() - Method in class com.pingidentity.pa.sdk.http.MediaType
Retrieves the BaseType
getBody() - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
 
getBody() - Method in interface com.pingidentity.pa.sdk.http.client.ClientResponse
Gets the body content of the response.
getBody() - Method in interface com.pingidentity.pa.sdk.http.Message
Returns the body of this Message Note: when processing an Agent Request from a PingAccess agent, the headers of the Message might indicate a non-empty body should be returned, but an empty body will be returned.
getButtonGroup() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getCacheControl() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Cache-Control HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getCategory() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationOption
Returns the category
getCertificates() - Method in class com.pingidentity.pa.sdk.accessor.certgroup.TrustedCertificateGroupModel
 
getCharset() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the Charset from the first Content-Type HeaderField.
getCharset() - Method in class com.pingidentity.pa.sdk.http.MediaType
Retrieve the charset parameter as a Charset object.
getClientCertificateChain() - Method in interface com.pingidentity.pa.sdk.ssl.SslData
Gets the client certificate chain.
getClientId() - Method in interface com.pingidentity.pa.sdk.identity.OAuthTokenMetadata
Returns the client_id of the OAuth client that was issued the token or null if not present.
getCode() - Method in class com.pingidentity.pa.sdk.http.HttpStatus
Retrieves the Status-Code, which is a 3-digit integer result code of the attempt to understand and satisfy the request.
getConfiguration() - Method in class com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingPluginBase
 
getConfiguration() - Method in class com.pingidentity.pa.sdk.ha.lb.LoadBalancingPluginBase
getConfiguration() - Method in class com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPluginBase
 
getConfiguration() - Method in class com.pingidentity.pa.sdk.identitymapping.IdentityMappingPluginBase
getConfiguration() - Method in interface com.pingidentity.pa.sdk.plugins.ConfigurablePlugin
Retrieves the configuration provided to this ConfigurablePlugin.
getConfiguration() - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
getConfiguration() - Method in class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
Returns the provided implementation of PluginConfiguration
getConfiguration() - Method in class com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptorBase
 
getConfiguration() - Method in class com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptorBase
getConfigurationFields() - Method in interface com.pingidentity.pa.sdk.plugins.DescribesUIConfigurable
Returns an ordered set of ConfigurationFields.
getConfigurationFields() - Static method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerUtil
 
getConfigurationModelAccessor(Class<T>) - Method in interface com.pingidentity.pa.sdk.accessor.ConfigurationModelAccessorFactory
Get an initialized instance of the specified concrete ConfigurationModelAccessor.
getConnection() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Connection HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getContent() - Method in interface com.pingidentity.pa.sdk.http.Body
Gets the body content as a byte array, if the body content is available in memory--Body.isInMemory() returns true when this is the case.
getContent() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
getContentDisposition() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Content-Disposition HeaderField.
getContentEncoding() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Content-Encoding HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getContentLength() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the length, in bytes, of the associated message body.
getContentLocation() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Content-Location HeaderField.
getContentType() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets a MediaType representing the value fo the first Content-Type HeaderField.
getContextRoot() - Method in interface com.pingidentity.pa.sdk.policy.Application
Returns the first part of the URL path for this Application and its Resources
getCookies() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets a map of HTTP cookies extracted from any Cookie HeaderFields.
getCreationTime() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Gets the time the Exchange was created.
getDate() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Date HeaderField.
getDefaultValue() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getDependantFieldAccessor(Class<T>) - Method in interface com.pingidentity.pa.sdk.accessor.DependantFieldAccessorFactory
Get an initialized instance of the specified concrete DependantFieldAccessor
getDependentFieldOptions() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationParentField
 
getDependentFieldOptions() - Method in class com.pingidentity.pa.sdk.ui.DynamicConfigurationParentField
 
getDescription(String...) - Method in enum com.pingidentity.pa.sdk.localization.ErrorDescription
Gets a description that will not be localized.
getDomain() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Retrieves the domain
getErrorCause() - Method in exception com.pingidentity.pa.sdk.policy.AccessException
 
getErrorCause() - Method in interface com.pingidentity.pa.sdk.policy.error.ErrorInfo
Retrieves the Throwable that caused the error.
getErrorHandlingCallback() - Method in interface com.pingidentity.pa.sdk.policy.AsyncRuleInterceptor
Provides an instance of ErrorHandlingCallback that renders errors if the AsyncRuleInterceptor is selected to render errors.
getErrorHandlingCallback() - Method in interface com.pingidentity.pa.sdk.policy.RuleInterceptor
Provides an instance of ErrorHandlingCallback that renders errors if the RuleInterceptor is selected to render errors.
getErrorMessage() - Method in exception com.pingidentity.pa.sdk.policy.AccessException
 
getErrorMessage() - Method in interface com.pingidentity.pa.sdk.policy.error.ErrorInfo
Retrieves the primary error message to be presented to the end-user in the body of the response, which may be localized for the current locale.
getErrorResponseCode() - Method in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
getErrorResponseCode() - Method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
getErrorResponseContentType() - Method in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
getErrorResponseContentType() - Method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
getErrorResponseStatusMsg() - Method in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
getErrorResponseStatusMsg() - Method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
getErrorResponseTemplateFile() - Method in interface com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfiguration
 
getErrorResponseTemplateFile() - Method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
getErrorStatus() - Method in exception com.pingidentity.pa.sdk.policy.AccessException
 
getErrorStatus() - Method in interface com.pingidentity.pa.sdk.policy.error.ErrorInfo
Retrieves the response status, which encapsulates both the status code (e.g.
getExpiresAt() - Method in interface com.pingidentity.pa.sdk.identity.OAuthTokenMetadata
Returns the calculated value for the expires_in field presented in the OAuth access token response or null if not present.
getFieldName() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationParentField
 
getFields() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getFirstCookieValue(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value of the first cookie with the specified name
getFirstValue(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the first value from the first HeaderField with the specified name where values within a HeaderField value are separated by a comma, excluding commas in a quoted string or comment blocks.
getHandler(H) - Method in interface com.pingidentity.pa.sdk.plugins.EntityScopedHandlerPlugin
Gets the handler instance given the existing handler.
getHandler() - Method in interface com.pingidentity.pa.sdk.plugins.EntityScopedHandlerPlugin
Creates a new handler instance.
getHeaderFields() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets a List containing all the HeaderFields in this Headers object.
getHeaderName() - Method in class com.pingidentity.pa.sdk.http.HeaderField
Gets the HeaderName
getHeaderName() - Method in class com.pingidentity.pa.sdk.identitymapping.header.AttributeHeaderPair
Returns the header name
getHeaders() - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
 
getHeaders() - Method in interface com.pingidentity.pa.sdk.http.client.ClientResponse
 
getHeaders() - Method in interface com.pingidentity.pa.sdk.http.Message
Returns the headers associated with this Message.
getHelp() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getHost() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Host HeaderField.
getHost() - Method in interface com.pingidentity.pa.sdk.http.TargetHost
 
getHttpClient() - Method in class com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingPluginBase
 
getHttpClient() - Method in class com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPluginBase
 
getHttpClient() - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
getHttpClient() - Method in class com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptorBase
 
getId() - Method in class com.pingidentity.pa.sdk.accessor.certgroup.TrustedCertificateGroupModel
 
getId() - Method in class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
 
getId() - Method in class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
 
getId() - Method in interface com.pingidentity.pa.sdk.http.TargetHost
Gets a unique integer identifier for this instance.
getIdentifier() - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
 
getIdentity() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Returns the user identity or null if no identity is associated with the Exchange.
getImplClasses(Class<T>) - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Acquires the list of implementation classes when multiple classes may be provided.
getImplInstances(Class<T>) - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Acquires the list of the implementation instances when multiple instances may be provided.
getKey() - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
Retrieves a unique key for this property, which is a concatenation of the namespace and identifier, in the form:
getLabel() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getLabel() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationOption
Returns the label
getLastModified() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Last-Modified HeaderField.
getLastValue(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the last value for the last HeaderField with the specified name where values within a HeaderField value are separated by a comma, excluding commas in a quoted string or comment blocks.
getLength() - Method in interface com.pingidentity.pa.sdk.http.Body
Gets the length of the body content, if the body content is available in memory--Body.isInMemory() returns true when this is the case.
getLocales() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the locales in order of preference specified in the Accept-Language header.
getLocalizationKey() - Method in enum com.pingidentity.pa.sdk.localization.ErrorDescription
Gets the key used to resolve the localized error description.
getLocalizedMessage() - Method in class com.pingidentity.pa.sdk.http.HttpStatus
Retrieves the localized status message, which may be more suitable for presenting to an end-user in a response.
getLocalizedMessageResolver() - Method in interface com.pingidentity.pa.sdk.util.TemplateRenderer
Gets an instance of LocalizedMessageResolver
getLocation() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Location HeaderField.
getMappedSubject() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the subject as set by a IdentityMappingPlugin.
getMessage() - Method in class com.pingidentity.pa.sdk.http.HttpStatus
Retrieves the standard Reason-Phrase, which is intended to give a short textual description of the Status-Code to a human user.
getMethod() - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
 
getMethod() - Method in interface com.pingidentity.pa.sdk.http.Request
Retrieves the request's method.
getModelAccessorClass() - Method in class com.pingidentity.pa.sdk.ui.DynamicOptionsConfigurationField
 
getModifiedHeaderNames() - Method in interface com.pingidentity.pa.sdk.http.Headers
 
getName() - Method in class com.pingidentity.pa.sdk.accessor.certgroup.TrustedCertificateGroupModel
 
getName() - Method in class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
 
getName() - Method in class com.pingidentity.pa.sdk.http.Method
 
getName() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Retrieves the Name
getName() - Method in interface com.pingidentity.pa.sdk.policy.Application
Returns the name of this Application
getName() - Method in interface com.pingidentity.pa.sdk.policy.PluginConfiguration
Provides the name defined by the PingAccess Administrator.
getName() - Method in interface com.pingidentity.pa.sdk.policy.Resource
Returns the name of this Resource
getName() - Method in class com.pingidentity.pa.sdk.policy.SimplePluginConfiguration
 
getName() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getNamespace() - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
 
getOAuthTokenMetadata() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns additional data about an OAuth token when the authentication source is OAuth.
getOptions() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationDependentFieldOption
 
getOptions() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getOptions() - Method in class com.pingidentity.pa.sdk.ui.DynamicOptionsConfigurationField
 
getOrigin() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Origin HeaderField.
getOriginalRequestUri() - Method in interface com.pingidentity.pa.sdk.http.Exchange
The Request URI provided in the Request's start line.
getParameter(String) - Method in class com.pingidentity.pa.sdk.http.MediaType
Retrieves a specified parameter
getParameters() - Method in class com.pingidentity.pa.sdk.http.MediaType
Gets the parameter map.
getParentField() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getPath() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Retrieves the path
getPathPatterns() - Method in interface com.pingidentity.pa.sdk.policy.Resource
Returns a read-only set of the URL path-matching patterns (relative to Application.getContextRoot()) that identify this Resource.
getPathPrefixes() - Method in interface com.pingidentity.pa.sdk.policy.Resource
Deprecated.
This method may be removed in a future release. Please use Resource.getPathPatterns() instead.
getPattern() - Method in interface com.pingidentity.pa.sdk.policy.PathPattern
 
getPolicyConfiguration() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Returns the PolicyConfiguration containing details about the policy configuration for the current Exchange
getPort() - Method in interface com.pingidentity.pa.sdk.http.TargetHost
 
getPredefinedMethods() - Static method in class com.pingidentity.pa.sdk.http.Method
 
getPreferredLocales(Exchange) - Method in interface com.pingidentity.pa.sdk.localization.LocaleOverrideService
Resolves preferred locales for the given request.
getPrimaryType() - Method in class com.pingidentity.pa.sdk.http.MediaType
Retrieves the PrimaryType
getPrivateKeyEntry() - Method in class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
 
getProperty(ExchangeProperty<T>) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Retrieves a property from this exchange.
getProxyAuthorization() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Proxy-Authorization HeaderField.
getProxyConnection() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Proxy-Connection HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getQueryStringParams() - Method in interface com.pingidentity.pa.sdk.http.Request
Parses and returns a map of Params from the query string.
getRealm() - Method in interface com.pingidentity.pa.sdk.identity.OAuthTokenMetadata
Returns the OAuth realm associated with the application.
getRemovedHeaderNames() - Method in interface com.pingidentity.pa.sdk.http.Headers
 
getRenderer() - Method in class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
Accessor for injected TemplateRenderer
getRequest() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Gets the Request Object.
getRequestTarget() - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
 
getRequiredProperty(ExchangeProperty<T>) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Retrieves a property from this exchange, throwing an unchecked exception if no value is present.
getResolvedLocale() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Get the resolved Locale of the request, as determined by the LocaleOverrideService and the request data.
getResource() - Method in interface com.pingidentity.pa.sdk.policy.PolicyConfiguration
Returns the Resource configured for this policy configuration
getResponse() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Gets the response.
getRetrievedAt() - Method in interface com.pingidentity.pa.sdk.identity.OAuthTokenMetadata
Returns the time when PingAccess received the OAuth access token response.
getScopes() - Method in interface com.pingidentity.pa.sdk.identity.OAuthTokenMetadata
Returns the scope of the OAuth access token or empty if not present.
getSecWebSocketAccept() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Sec-WebSocket-Accept HeaderField.
getSecWebSocketExtensions() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Sec-WebSocket-Extensions HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getSecWebSocketKey() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Sec-WebSocket-Key HeaderField.
getSecWebSocketProtocol() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Sec-WebSocket-Protocol HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getSecWebSocketVersion() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the first value from the first Sec-WebSocket-Version HeaderField.
getServer() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first Server HeaderField.
getSessionStateSupport() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the session state for the exchange.
getSetCookie() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values from the Set-Cookie HeaderFields in this Headers object.
getSingleImpl(Class<T>) - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Acquires the implementation when one and only one implementation is expected.
getSniServerNames() - Method in interface com.pingidentity.pa.sdk.ssl.SslData
Gets the SNI server names sent by the client during the SSL/TLS handshake.
getSourceIp() - Method in interface com.pingidentity.pa.sdk.http.Exchange
The source IP address for the socket over which the Request was received.
getSslData() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Returns SslData from the SSL/TLS connection.
getStartLine() - Method in interface com.pingidentity.pa.sdk.http.Message
Returns the Start-Line for this Message.
getStatus() - Method in interface com.pingidentity.pa.sdk.http.client.ClientResponse
 
getStatus() - Method in interface com.pingidentity.pa.sdk.http.Response
 
getStatusCode() - Method in interface com.pingidentity.pa.sdk.http.Response
Gets the code of this Response's HttpStatus
getStatusMessage() - Method in interface com.pingidentity.pa.sdk.http.Response
Gets the message of this Response's HttpStatus
getSubject() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the subject for the authenticated identity.
getSubType() - Method in class com.pingidentity.pa.sdk.http.MediaType
Retrieves the SubType
getTargetHosts() - Method in interface com.pingidentity.pa.sdk.http.Exchange
 
getTargetScheme() - Method in interface com.pingidentity.pa.sdk.http.Exchange
 
getTemplateRenderer() - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
getTitle() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
getTokenExpiration() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the expiration time presented from the authentication source.
getTokenId() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the unique ID presented in the authentication token.
getTokenType() - Method in interface com.pingidentity.pa.sdk.identity.OAuthTokenMetadata
Returns the token_type of the OAuth access token.
getTrackingId() - Method in interface com.pingidentity.pa.sdk.identity.Identity
Returns the tracking identifier used in the PingAccess logs for this identity.
getTransferEncoding() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values from the Transfer-Encoding HeaderFields in this Headers object.
getType() - Method in exception com.pingidentity.pa.sdk.http.client.HttpClientException
 
getType() - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
 
getType() - Method in interface com.pingidentity.pa.sdk.policy.Application
Returns the type of this Application
getType() - Method in interface com.pingidentity.pa.sdk.policy.PathPattern
 
getType() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
getUpgrade() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Upgrade HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getUri() - Method in interface com.pingidentity.pa.sdk.http.Request
Retrieves the request's URI from the start line In this context, a URI is the path and query component of the URL for the resource.
getURIs() - Method in interface com.pingidentity.pa.sdk.http.Headers
Returns all URI headers, including any variants defined via the vary parameter.
getUrl() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
getUserAgentHost() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Returns the value of the Host header field from the HTTP request sent by the user agent, as determined by the PingAccess HTTP requests configuration and the Request data.
getUserAgentIp() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Returns the IP of the user agent, as determined by the PingAccess HTTP requests configuration and the Request data.
getUserAgentProtocol() - Method in interface com.pingidentity.pa.sdk.http.Exchange
Returns the protocol used by the user agent to initiate the associated Request, as determined by the PingAccess HTTP requests configuration and the Request data.
getValue() - Method in class com.pingidentity.pa.sdk.http.HeaderField
Returns the value
getValue() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Retrieves the value
getValue() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationDependentFieldOption
 
getValue() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationOption
Returns the value
getValues(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the values of all the HeaderFields with the specified name.
getVary() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the Vary HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getVersion() - Method in interface com.pingidentity.pa.sdk.http.Message
Returns the Start-Line version string.
getXForwardedFor() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the X-Forwarded-For HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getXForwardedHost() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets all the values for the X-Forwarded-Host HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
getXForwardedProto() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the first value from the first X-Forwarded-Proto HeaderField.
getXFrameOptions() - Method in interface com.pingidentity.pa.sdk.http.Headers
Gets the value from the first X-Frame-Options HeaderField.
GONE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 

H

handleRequest(Exchange) - Method in interface com.pingidentity.pa.sdk.interceptor.RequestInterceptor
Called to handle request processing and manipulation as part of a sequence of a Interceptors.
handleRequest(Exchange) - Method in interface com.pingidentity.pa.sdk.policy.AsyncRuleInterceptor
Invoked to allow a AsyncRuleInterceptor to allow or deny further processing of a request.
handleRequest(Exchange) - Method in class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
Default implementation of RequestInterceptor.handleRequest(Exchange) that always returns Outcome.CONTINUE.
handleRequest(Exchange) - Method in interface com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptor
Invoked to allow a AsyncSiteAuthenticatorInterceptor to handle the request attached to the Exchange.
handleRequest(Exchange) - Method in interface com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptor
Called to allow this SiteAuthenticatorInterceptor to modify the Request attached to the Exchange
handleResponse(Exchange, TargetHost) - Method in interface com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingHandler
Updates any internal data based on the response and optionally updates the response.
handleResponse(Exchange, TargetHost) - Method in interface com.pingidentity.pa.sdk.ha.lb.LoadBalancingHandler
Updates any internal data based on the response and optionally updates the response.
handleResponse(Exchange, TargetHost) - Method in class com.pingidentity.pa.sdk.ha.lb.LoadBalancingStrategy.NONE
 
handleResponse(Exchange) - Method in interface com.pingidentity.pa.sdk.interceptor.ResponseInterceptor
Called to handle response processing and manipulation as part of an interceptor chain.
handleResponse(Exchange) - Method in interface com.pingidentity.pa.sdk.policy.AsyncRuleInterceptor
Invoked to allow a AsyncRuleInterceptor to handle the response attached to the Exchange.
handleResponse(Exchange) - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
handleResponse(Exchange) - Method in class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
Default implementation of ResponseInterceptor.handleResponse(Exchange) that does nothing.
handleResponse(Exchange) - Method in interface com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptor
Invoked to allow a AsyncSiteAuthenticatorInterceptor to handle the response attached to the Exchange.
handleResponse(Exchange) - Method in interface com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptor
Called to allow this SiteAuthenticatorInterceptor to modify the Response attached to the Exchange.
handleResponse(Exchange) - Method in class com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptorBase
Provides an empty implementation of ResponseInterceptor since most implementations of SiteAuthenticatorInterceptor do not need to examine or manipulate the response.
hashCode() - Method in class com.pingidentity.pa.sdk.accessor.certgroup.TrustedCertificateGroupModel
 
hashCode() - Method in class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
 
hashCode() - Method in class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
Similar to ClientRequest.equals(Object), the hash code is computed based on the serialized representation
hashCode() - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.HeaderField
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.HeaderName
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.HttpStatus
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.MediaType
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.Method
 
hashCode() - Method in class com.pingidentity.pa.sdk.http.SetCookie
 
hashCode() - Method in class com.pingidentity.pa.sdk.identitymapping.header.AttributeHeaderPair
Returns a hash code such that equal AttributeHeaderPairs will have the same code.
HEAD - Static variable in class com.pingidentity.pa.sdk.http.Method
 
header(HeaderField) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Adds a HeaderField to the Headers of the Response.
header(String, String) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Adds a HeaderField to the Response.
HEADER_NAME_WWW_AUTHENTICATE - Static variable in class com.pingidentity.pa.sdk.oauth.OAuthConstants
 
HeaderField - Class in com.pingidentity.pa.sdk.http
Represents an individual header field in an HTTP message.
HeaderField(HeaderName, String) - Constructor for class com.pingidentity.pa.sdk.http.HeaderField
Constructor for an individual HeaderField
HeaderField(String, String) - Constructor for class com.pingidentity.pa.sdk.http.HeaderField
Constructor for an individual HeaderField
HeaderField(HeaderField) - Constructor for class com.pingidentity.pa.sdk.http.HeaderField
HeaderField copyConstructor
HeaderIdentityMappingPlugin<P extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.identitymapping.header
An abstract base class that can be extended to handle simple identity mapping where attribute names are mapped to header names.
HeaderIdentityMappingPlugin() - Constructor for class com.pingidentity.pa.sdk.identitymapping.header.HeaderIdentityMappingPlugin
 
HeaderName - Class in com.pingidentity.pa.sdk.http
An immutable, case-insensitive HTTP header name (per RFC 7230).
HeaderName(String) - Constructor for class com.pingidentity.pa.sdk.http.HeaderName
 
Headers - Interface in com.pingidentity.pa.sdk.http
An ordered collection of zero or more HeaderFields.
headers(Headers) - Method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Sets the Headers object for the Response.
HeadersFactory - Interface in com.pingidentity.pa.sdk.http
Factory for acquiring a Headers implementation.
headersFactory() - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Helper method to provide an implementation of HeadersFactory.
help() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Creates Help on the last ConfigurationField.
Help() - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
Help(ConfigurationField.Help) - Constructor for class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
Help - Annotation Type in com.pingidentity.pa.sdk.ui
Annotation used to define the Help for a UIElement
helpContent(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the content on the last ConfigurationField's Help.
helpTitle(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the title on the last ConfigurationField's Help.
helpURL(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the URL on the last ConfigurationField's Help.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
HttpClient - Interface in com.pingidentity.pa.sdk.http.client
Provides methods to make outbound HTTP calls, leveraging a ThirdPartyServiceModel to encapsulate the configuration for the destination of the call.
HttpClientException - Exception in com.pingidentity.pa.sdk.http.client
An Exception used by a HttpClient to indicate that it failed to retrieve a ClientResponse from the target of a ClientRequest.
HttpClientException(HttpClientException.Type, String, Throwable) - Constructor for exception com.pingidentity.pa.sdk.http.client.HttpClientException
 
HttpClientException.Type - Enum in com.pingidentity.pa.sdk.http.client
An enum for the type of failure represented by this exception
httpOnly(boolean) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the HttpOnly flag
httpOnly() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the HttpOnly flag to true
HttpStatus - Class in com.pingidentity.pa.sdk.http
An immutable HTTP response status code and its corresponding message (reason phrase).
HttpStatus(int, String, LocalizedMessage) - Constructor for class com.pingidentity.pa.sdk.http.HttpStatus
Constructs a new HttpStatus.
HttpStatus(int, String) - Constructor for class com.pingidentity.pa.sdk.http.HttpStatus
Constructs a new HttpStatus without any localization support.

I

Identity - Interface in com.pingidentity.pa.sdk.identity
An Identity object contains attributes and associated values derived from an authentication token issued by a token provider.
IdentityMapping - Annotation Type in com.pingidentity.pa.sdk.identitymapping
Used to mark a IdentityMappingPlugin.
IdentityMappingPlugin<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.identitymapping
A IdentityMappingPlugin is the runtime instantiation of an Identity Mapping defined in the Administrative API.
IdentityMappingPluginBase<T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.identitymapping
A Base class designed to simplify implementing a IdentityMappingPlugin
IdentityMappingPluginBase() - Constructor for class com.pingidentity.pa.sdk.identitymapping.IdentityMappingPluginBase
 
initialize(String) - Method in interface com.pingidentity.sdk.key.MasterKeyEncryptor
Initializes the MasterKeyEncryptor allowing implementations to perform any external key management operations, such as creating/loading an external key.
Interceptor - Interface in com.pingidentity.pa.sdk.interceptor
An Interceptor is the "receiving object" for an Exchange, where a receiving object is defined by the "Chain-of-responsibility" pattern.
INTERNAL_SERVER_ERROR - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
internalServerError() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "500 Internal Server Error" status.
isAdvanced() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
isAnonymous() - Method in interface com.pingidentity.pa.sdk.policy.Resource
Returns true if this Resource has no authentication requirements
isChunked() - Method in interface com.pingidentity.pa.sdk.http.Headers
Helper method to determine if this Headers object contains header fields that indicate the related HTTP message body uses a chunked Transfer-Encoding.
isDeselectable() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
isHttpOnly() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Retrieves the HttpOnly flag
isIdempotent() - Method in class com.pingidentity.pa.sdk.http.Method
A method is "idempotent" if the client intended either no modification, or a consistent modification.
isInMemory() - Method in interface com.pingidentity.pa.sdk.http.Body
Returns true if the body content is in memory.
isKeepAlive() - Method in interface com.pingidentity.pa.sdk.http.Message
Indicates whether or not this Message is a KeepAlive transaction.
isPrimaryTypeWildcard() - Method in class com.pingidentity.pa.sdk.http.MediaType
Determines if the PrimaryType is a wildcard
isPropertyTrue(ExchangeProperty<Boolean>) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Determines if a boolean property is set to true.
isRead() - Method in interface com.pingidentity.pa.sdk.http.Body
Returns true if the body content has been read.
isRequestBodyEmpty() - Method in class com.pingidentity.pa.sdk.http.Method
Identifies whether the request body for this method is empty or not.
isRequired() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
isSafe() - Method in class com.pingidentity.pa.sdk.http.Method
A Method is "safe" if it is only meant for retrieval.
isSecure() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Retrieves the Secure flag
isSecure() - Method in interface com.pingidentity.pa.sdk.http.TargetHost
 
isSubject() - Method in class com.pingidentity.pa.sdk.identitymapping.header.AttributeHeaderPair
Returns true if this AttributeHeaderPair represents the subject
isSubTypeWildcard() - Method in class com.pingidentity.pa.sdk.http.MediaType
Determines if the SubType is a wildcard
isUnprotected() - Method in interface com.pingidentity.pa.sdk.policy.Resource
Returns true if this Resource has no authentication requirements and doesn't do any identity processing.
isValidImplName(Class<T>, String) - Static method in class com.pingidentity.pa.sdk.services.ServiceFactory
Checks whether the given classname is a valid implementation of the SPI class.

J

JSON - Static variable in class com.pingidentity.pa.sdk.http.CommonMediaTypes
MediaType for application/json, using the UTF-8 Charset

K

KeyPairAccessor - Interface in com.pingidentity.pa.sdk.accessor.keypair
A ConfigurationModelAccessor to access key pairs configured via the PingAccess Administrative API.
KeyPairModel - Class in com.pingidentity.pa.sdk.accessor.keypair
Represents a key pair configured in the Administrative API.
KeyPairModel(String, String, KeyStore.PrivateKeyEntry) - Constructor for class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
Construct a KeyPairModel.

L

LABEL - Static variable in class com.pingidentity.pa.sdk.http.Method
 
label(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the label on the last ConfigurationField
LENGTH_REQUIRED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
LINK - Static variable in class com.pingidentity.pa.sdk.http.Method
 
LoadBalancingHandler - Interface in com.pingidentity.pa.sdk.ha.lb
A LoadBalancingHandler is the runtime component of a LoadBalancingStrategy that provides the logic for load balancing requests to TargetHosts configured for a Site.
LoadBalancingPlugin<H extends LoadBalancingHandler,C extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.ha.lb
A LoadBalancingPlugin is the runtime instantiation of a Load Balancing Strategy, defined in the Administrative API.
LoadBalancingPluginBase<H extends LoadBalancingHandler,T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.ha.lb
A Base class designed to simplify implementing a LoadBalancingPlugin.
LoadBalancingPluginBase() - Constructor for class com.pingidentity.pa.sdk.ha.lb.LoadBalancingPluginBase
 
LoadBalancingStrategy - Annotation Type in com.pingidentity.pa.sdk.ha.lb
Required annotation for defining LoadBalancingStrategies.
LoadBalancingStrategy.NONE - Class in com.pingidentity.pa.sdk.ha.lb
 
LocaleOverrideService - Interface in com.pingidentity.pa.sdk.localization
A LocaleOverrideService is a singleton plugin that can apply custom logic for resolving the locale of a HTTP request.
LocalizedInternalServerErrorCallback - Class in com.pingidentity.pa.sdk.policy.error
An implementation of ErrorHandlingCallback that localizes the internal server error message
LocalizedInternalServerErrorCallback(LocalizedMessageResolver) - Constructor for class com.pingidentity.pa.sdk.policy.error.LocalizedInternalServerErrorCallback
 
LocalizedMessage - Interface in com.pingidentity.pa.sdk.localization
A message that can be resolved for a specific Locale.
LocalizedMessageResolver - Interface in com.pingidentity.pa.sdk.localization
Resolves localized strings from the pa-messages properties files located in the conf/localization directory in the PingAccess installation.
LOCK - Static variable in class com.pingidentity.pa.sdk.http.Method
 

M

mapAnonymousIdentity(Request, Exchange) - Method in interface com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPlugin
Maps the anonymous identity.
mapAnonymousIdentity(Request, Exchange) - Method in class com.pingidentity.pa.sdk.identitymapping.header.HeaderIdentityMappingPlugin
 
mapAnonymousIdentity(Request, Exchange) - Method in interface com.pingidentity.pa.sdk.identitymapping.IdentityMappingPlugin
Maps the anonymous identity.
mapIdentity(Identity, Request, Exchange) - Method in interface com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPlugin
Maps the identity by inspecting the identity associated with the request and making modifications to the request and/or exchange.
mapIdentity(Identity, Request, Exchange) - Method in class com.pingidentity.pa.sdk.identitymapping.header.HeaderIdentityMappingPlugin
 
mapIdentity(Identity, Request, Exchange) - Method in interface com.pingidentity.pa.sdk.identitymapping.IdentityMappingPlugin
Maps the identity by inspecting the identity associated with the request and making modifications to the request and/or exchange.
MasterKeyEncryptor - Interface in com.pingidentity.sdk.key
An encryptor that can be used to encrypt PingAccess' master key file (pa.jwk).
MasterKeyEncryptorException - Exception in com.pingidentity.sdk.key
A general exception of the MasterKeyEncryptor.
MasterKeyEncryptorException() - Constructor for exception com.pingidentity.sdk.key.MasterKeyEncryptorException
Constructs a new MasterKeyEncryptorException with null as its detail message.
MasterKeyEncryptorException(String) - Constructor for exception com.pingidentity.sdk.key.MasterKeyEncryptorException
Constructs a new MasterKeyEncryptorException with the specified detail message.
MasterKeyEncryptorException(Throwable) - Constructor for exception com.pingidentity.sdk.key.MasterKeyEncryptorException
Constructs a new MasterKeyEncryptorException with the specified cause and a detail message of null
MasterKeyEncryptorException(String, Throwable) - Constructor for exception com.pingidentity.sdk.key.MasterKeyEncryptorException
Constructs a new MasterKeyEncryptorException with the specified detail message and cause
matches(String, String) - Method in class com.pingidentity.pa.sdk.http.MediaType
Checks for a match of both the primary type and subtype.
matchesBaseType(String) - Method in class com.pingidentity.pa.sdk.http.MediaType
Compares the BaseType of the provided ContentType to this.
matchesBaseType(MediaType) - Method in class com.pingidentity.pa.sdk.http.MediaType
Compares the BaseType of the provided ContentType to this.
maxAge(long, TimeUnit) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the cookie's MaxAge The duration value has second granularity
MediaType - Class in com.pingidentity.pa.sdk.http
Representation for a media type, commonly contained in a HTTP Content-Type and Accept header field value.
MediaType(String, String) - Constructor for class com.pingidentity.pa.sdk.http.MediaType
Constructor to build a MediaType
MediaType(String, String, Map<String, String>) - Constructor for class com.pingidentity.pa.sdk.http.MediaType
Constructor to build a MediaType from its individual components
MERGE - Static variable in class com.pingidentity.pa.sdk.http.Method
 
Message - Interface in com.pingidentity.pa.sdk.http
Interface defining the representation for a HTTP message.
Method - Class in com.pingidentity.pa.sdk.http
An immutable HTTP request method.
METHOD_NOT_ALLOWED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
MKACTIVITY - Static variable in class com.pingidentity.pa.sdk.http.Method
 
MKCALENDAR - Static variable in class com.pingidentity.pa.sdk.http.Method
 
MKCOL - Static variable in class com.pingidentity.pa.sdk.http.Method
 
MKREDIRECTREF - Static variable in class com.pingidentity.pa.sdk.http.Method
 
MKWORKSPACE - Static variable in class com.pingidentity.pa.sdk.http.Method
 
MOVE - Static variable in class com.pingidentity.pa.sdk.http.Method
 
MOVED_PERMANENTLY - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
MULTIPLE_CHOICES - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 

N

name(String) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the Name
name(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the name on the last ConfigurationField
NETWORK_AUTHENTICATION_REQUIRED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
newInputStream() - Method in interface com.pingidentity.pa.sdk.http.Body
Gets the body content as an InputStream, if the body content is available in memory--Body.isInMemory() returns true when this is the case.
newInstance(HttpStatus) - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder.
NO_CONTENT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
NON_AUTHORITATIVE_INFORMATION - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
NONE() - Constructor for class com.pingidentity.pa.sdk.ui.ParentField.NONE
 
NONE() - Constructor for class com.pingidentity.pa.sdk.ui.UIElement.NONE
 
NOT_ACCEPTABLE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
NOT_FOUND - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
NOT_IMPLEMENTED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
NOT_MODIFIED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
notFound() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "404 Not Found" status and a Content Type of "text/html;charset=UTF-8".
notFoundJson() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "404 Not Found" status and a content type of "application/json;charset=UTF-8".

O

OAuthAuthorizationServer - Annotation Type in com.pingidentity.pa.sdk.accessor.tps
This annotation is used to obtain a reference to the ThirdPartyServiceModel that corresponds to the OAuth authorization server configured in PingAccess, without requiring the administrator to configure a plugin to use the authorization server.
OAuthConstants - Class in com.pingidentity.pa.sdk.oauth
 
OAuthPolicyErrorHandlingCallback - Class in com.pingidentity.pa.sdk.policy.error
OAuthPolicyErrorHandlingCallback is used to respond to an OAuth policy failure.
OAuthPolicyErrorHandlingCallback(ErrorHandlerConfiguration, TemplateRenderer, Set<String>, String, String, String) - Constructor for class com.pingidentity.pa.sdk.policy.error.OAuthPolicyErrorHandlingCallback
Creates a new OAuthPolicyErrorHandlingCallback.
OAuthTokenMetadata - Interface in com.pingidentity.pa.sdk.identity
The OAuthTokenMetadata object provides access to additional details about an OAuth token apart from the attributes on Identity.
OAuthUtilities - Class in com.pingidentity.pa.sdk.oauth
OAuthUtilities is a utility class containing useful methods for OAuth.
OidcProvider - Annotation Type in com.pingidentity.pa.sdk.accessor.tps
This annotation is used to obtain a reference to the ThirdPartyServiceModel that corresponds to the OIDC provider configured in PingAccess, without requiring the administrator to configure a plugin to use the OIDC provider.
OK - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
ok(String) - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "200 OK" status, a Content-Type of "text/html;charset=UTF-8", and the provided string message as the Response body
ok() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "200 OK" status.
option(String, String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds an option to the last ConfigurationField
option(ConfigurationOption) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds an option to the last ConfigurationField
Option - Annotation Type in com.pingidentity.pa.sdk.ui
The annotation used to define options when using UIElement
options() - Method in interface com.pingidentity.pa.sdk.accessor.ConfigurationModelAccessor
Method for acquiring the Collection of ConfigurationOptions to be exposed in the plugin's descriptor in the Administrative API.
OPTIONS - Static variable in class com.pingidentity.pa.sdk.http.Method
 
options(Set<ConfigurationOption>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the options on the last ConfigurationField
options - Variable in class com.pingidentity.pa.sdk.ui.ConfigurationDependentFieldOption
 
options() - Method in class com.pingidentity.pa.sdk.ui.UIElement.NONE
 
ORDERPATCH - Static variable in class com.pingidentity.pa.sdk.http.Method
 
Outcome - Enum in com.pingidentity.pa.sdk.interceptor
The result returned by a RequestInterceptor.

P

ParameterizedLocalizedMessage - Class in com.pingidentity.pa.sdk.localization
A LocalizedMessage that resolves a message with placeholders.
ParameterizedLocalizedMessage(String, String...) - Constructor for class com.pingidentity.pa.sdk.localization.ParameterizedLocalizedMessage
Constructs a new ParameterizedLocalizedMessage from a localized message key and a set of substitution parameters.
parentField(ConfigurationParentField) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the ConfigurationParentField on the last set ConfigurationField.
ParentField - Annotation Type in com.pingidentity.pa.sdk.ui
The annotation used to define dependent fields when using UIElement
ParentField.NONE - Class in com.pingidentity.pa.sdk.ui
 
parse(String) - Static method in class com.pingidentity.pa.sdk.http.MediaType
Parses a MediaType from the specified String
parseFormParams() - Method in interface com.pingidentity.pa.sdk.http.Body
Parses form parameters from the body content, assuming the content is encoded following the encoding defined by the application/x-www-form-urlencoded content type and a default character encoding of UTF-8.
PARTIAL_CONTENT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
PATCH - Static variable in class com.pingidentity.pa.sdk.http.Method
 
path(String) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the path
PathPattern - Interface in com.pingidentity.pa.sdk.policy
A URL path-matching pattern.
PathPattern.Type - Enum in com.pingidentity.pa.sdk.policy
 
PAYMENT_REQUIRED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
PluginConfiguration - Interface in com.pingidentity.pa.sdk.policy
PluginConfiguration is the interface expected by the method ConfigurablePlugin.configure(PluginConfiguration).
POLICY_ERROR_INFO - Static variable in class com.pingidentity.pa.sdk.policy.error.RuleInterceptorErrorHandlingCallback
String value denoting the Error information for the Policy failure.
PolicyConfiguration - Interface in com.pingidentity.pa.sdk.policy
PolicyConfiguration contains details about a policy configuration
POST - Static variable in class com.pingidentity.pa.sdk.http.Method
 
PRECONDITION_FAILED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
PRECONDITION_REQUIRED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
privateKeysConfigurationField(String, String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Defines a ConfigurationField of type ConfigurationType.SELECT and applies KeyPairAccessor as the DynamicOptions
PROPFIND - Static variable in class com.pingidentity.pa.sdk.http.Method
 
PROPPATCH - Static variable in class com.pingidentity.pa.sdk.http.Method
 
PROXY_AUTHENTICATION_REQUIRED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
PUT - Static variable in class com.pingidentity.pa.sdk.http.Method
 

R

read() - Method in interface com.pingidentity.pa.sdk.http.Body
Read the body content into memory.
REBIND - Static variable in class com.pingidentity.pa.sdk.http.Method
 
removeAttribute(String) - Method in interface com.pingidentity.pa.sdk.identity.SessionStateSupport
Removes a session attribute.
removeFields(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Removes all HeaderFields with the specified name.
removeProperty(ExchangeProperty<?>) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Removes a property from this exchange, which is equivalent to setting the property to a null value.
render(Map<String, String>, String) - Method in interface com.pingidentity.pa.sdk.util.TemplateRenderer
Renders a template
render(Map<String, String>, String, Writer) - Method in interface com.pingidentity.pa.sdk.util.TemplateRenderer
Renders a template
renderResponse(Exchange, Map<String, String>, String, ResponseBuilder) - Method in interface com.pingidentity.pa.sdk.util.TemplateRenderer
Renders a template and produces a Response
REPORT - Static variable in class com.pingidentity.pa.sdk.http.Method
 
Request - Interface in com.pingidentity.pa.sdk.http
Interface for the request representation.
REQUEST_BODY_REQUIRED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
REQUEST_ENTITY_TOO_LARGE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
REQUEST_TIMEOUT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
REQUEST_URI_TOO_LONG - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
RequestInterceptor - Interface in com.pingidentity.pa.sdk.interceptor
An Interceptor that will be invoked when PingAccess is processing a HTTP request.
required() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds the Required flag on the last ConfigurationField and sets it to true
required(boolean) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds the Required flag to the last ConfigurationField and sets it to the specified value
RESET_CONTENT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
resolve(Locale, LocalizedMessageResolver) - Method in class com.pingidentity.pa.sdk.localization.BasicLocalizedMessage
 
resolve(Locale, LocalizedMessageResolver) - Method in class com.pingidentity.pa.sdk.localization.FixedMessage
 
resolve(Locale, LocalizedMessageResolver) - Method in interface com.pingidentity.pa.sdk.localization.LocalizedMessage
Resolves this message for a specific Locale.
resolve(Locale, LocalizedMessageResolver) - Method in class com.pingidentity.pa.sdk.localization.ParameterizedLocalizedMessage
 
resolveMessage(Locale, String) - Method in interface com.pingidentity.pa.sdk.localization.LocalizedMessageResolver
Resolves a localized string for a given Locale and property key
resolveMessage(Locale, String, String...) - Method in interface com.pingidentity.pa.sdk.localization.LocalizedMessageResolver
Resolves a localized string for a given Locale and property key
If the description contains place holders in the form '{0}', '{1}', '{2}', etc, they will be replaced with the substitutions vararg.
Resource - Interface in com.pingidentity.pa.sdk.policy
Resource represents part of Web application or API which has distinct security requirements
Response - Interface in com.pingidentity.pa.sdk.http
The interface defining representation for the HTTP response.
ResponseBuilder - Interface in com.pingidentity.pa.sdk.http
Builder used for creating Responses.
ResponseBuilder.Factory - Class in com.pingidentity.pa.sdk.http
A factory creating ResponseBuilder instances.
ResponseInterceptor - Interface in com.pingidentity.pa.sdk.interceptor
An Interceptor that will be invoked when PingAccess is processing a response.
Rule - Annotation Type in com.pingidentity.pa.sdk.policy
Required Annotation for defining Rules.
RuleInterceptor<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.policy
A RuleInterceptor is the runtime instantiation of a Rule defined in the Administrative API.
RuleInterceptorBase<T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.policy
A base class to simplify implementing RuleInterceptor.
RuleInterceptorBase() - Constructor for class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
 
RuleInterceptorCategory - Enum in com.pingidentity.pa.sdk.policy
This enum defines the values used by Rule.category()
RuleInterceptorErrorHandlingCallback - Class in com.pingidentity.pa.sdk.policy.error
 
RuleInterceptorErrorHandlingCallback(TemplateRenderer, ErrorHandlerConfiguration) - Constructor for class com.pingidentity.pa.sdk.policy.error.RuleInterceptorErrorHandlingCallback
 
RuleInterceptorSupportedDestination - Enum in com.pingidentity.pa.sdk.policy
Enum that defines the valid Destinations for Rule.destination().

S

SEARCH - Static variable in class com.pingidentity.pa.sdk.http.Method
 
secure(boolean) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the Secure flag
secure() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the Secure flag to true
SEE_OTHER - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
send(ClientRequest, ThirdPartyServiceModel) - Method in interface com.pingidentity.pa.sdk.http.client.HttpClient
Sends the specified ClientRequest to the third-party service represented by the ThirdPartyServiceModel.
SERVICE_UNAVAILABLE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
ServiceFactory - Class in com.pingidentity.pa.sdk.services
This class is used to discover and cache interface instances.
serviceUnavailable() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "503 Service Unavailable" status.
SessionStateSupport - Interface in com.pingidentity.pa.sdk.identity
SessionStateSupport provides access to persistent data across exchanges.
setAccept(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Accept HeaderFields in this Headers object.
setAccessControlAllowCredentials(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Access-Control-Allow-Credentials HeaderField.
setAccessControlAllowHeaders(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Access-Control-Allow-Headers HeaderFields in this Headers object.
setAccessControlAllowMethods(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Access-Control-Allow-Methods HeaderFields in this Headers object.
setAccessControlAllowOrigin(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Access-Control-Allow-Origin HeaderField.
setAccessControlExposeHeaders(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Access-Control-Expose-Headers HeaderFields in this Headers object.
setAccessControlMaxAge(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Access-Control-Max-Age HeaderField.
setAccessControlRequestHeaders(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Access-Control-Request-Headers HeaderFields in this Headers object.
setAccessControlRequestMethod(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Access-Control-Request-Method HeaderField.
setAdvanced(boolean) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setAttribute(String, JsonNode) - Method in interface com.pingidentity.pa.sdk.identity.SessionStateSupport
Sets a session attribute.
setAuthorization(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Authorization HeaderField.
setBody(Body) - Method in interface com.pingidentity.pa.sdk.http.Message
Sets the body of this Message.
setBodyContent(byte[]) - Method in interface com.pingidentity.pa.sdk.http.Message
Sets the body content of this Message.
setButtonGroup(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setCacheControl(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Cache-Control HeaderFields in this Headers object.
setConnection(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the Connection HeaderFields in this Headers object.
setContent(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
setContentDisposition(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Content-Disposition HeaderField.
setContentEncoding(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the Content-Encoding HeaderFields in this Headers object.
setContentLength(long) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Content-Length HeaderField.
setContentLocation(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Content-Location HeaderField.
setContentType(MediaType) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Content-Type HeaderField.
setContentType(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Content-Type HeaderField.
SetCookie - Class in com.pingidentity.pa.sdk.http
A utility class used to create a SetCookie header
SetCookie() - Constructor for class com.pingidentity.pa.sdk.http.SetCookie
 
setCookies(Map<String, String[]>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces the cookies in this Headers object with the specified cookies.
setDate(Instant) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Date HeaderField.
setDefaultValue(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setDeselectable(boolean) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setFields(List<ConfigurationField>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setFirstValue(String, String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value of the first HeaderField with the specified name.
setHeaders(Headers) - Method in interface com.pingidentity.pa.sdk.http.Message
Sets the headers to be associated with this Message.
setHelp(ConfigurationField.Help) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setHost(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Host HeaderField.
setHttpClient(HttpClient) - Method in class com.pingidentity.pa.sdk.ha.lb.AsyncLoadBalancingPluginBase
setHttpClient(HttpClient) - Method in class com.pingidentity.pa.sdk.identitymapping.AsyncIdentityMappingPluginBase
setHttpClient(HttpClient) - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
Sets the HttpClient for this AsyncRuleInterceptor.
setHttpClient(HttpClient) - Method in class com.pingidentity.pa.sdk.siteauthenticator.AsyncSiteAuthenticatorInterceptorBase
setLabel(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setLastModified(Instant) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Last-Modified HeaderField.
setLastValue(String, String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value of the last HeaderField with the specified name.
setLocation(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Location HeaderField.
setMappedSubject(String) - Method in interface com.pingidentity.pa.sdk.identity.Identity
Called by a IdentityMappingPlugin to set the subject.
setMethod(Method) - Method in interface com.pingidentity.pa.sdk.http.Request
Sets the request's method.
setName(String) - Method in interface com.pingidentity.pa.sdk.policy.PluginConfiguration
Sets the configured name.
setName(String) - Method in class com.pingidentity.pa.sdk.policy.SimplePluginConfiguration
 
setName(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setOptions(Collection<ConfigurationOption>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setOrigin(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Origin HeaderField.
setParentField(ConfigurationParentField) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setProperty(ExchangeProperty<T>, T) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Stores a property in this exchange.
setProxyAuthorization(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Proxy-Authorization HeaderField.
setProxyConnection(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the Proxy-Connection HeaderFields in this Headers object.
setRenderer(TemplateRenderer) - Method in class com.pingidentity.pa.sdk.policy.RuleInterceptorBase
Allows Inject to be used to set the TemplateRenderer.
setRequest(Request) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Sets the Request.
setRequired(boolean) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setResponse(Response) - Method in interface com.pingidentity.pa.sdk.http.Exchange
Sets the Response on this Exchange.
setSecWebSocketAccept(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Sec-WebSocket-Accept HeaderField.
setSecWebSocketExtensions(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Sec-WebSocket-Extensions HeaderFields in this Headers object.
setSecWebSocketKey(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Sec-WebSocket-Key HeaderField.
setSecWebSocketProtocol(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Sec-WebSocket-Protocol HeaderFields in this Headers object.
setSecWebSocketVersion(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Sec-WebSocket-Version HeaderField.
setServer(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first Server HeaderField.
setSetCookie(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Set-Cookie HeaderFields in this Headers object.
setStatus(HttpStatus) - Method in interface com.pingidentity.pa.sdk.http.Response
 
setTemplateRenderer(TemplateRenderer) - Method in class com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase
 
setTitle(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
setTransferEncoding(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the Transfer-Encoding HeaderFields in this Headers object.
setType(ConfigurationType) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
 
setUpgrade(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the Upgrade HeaderFields in this Headers object.
setUri(String) - Method in interface com.pingidentity.pa.sdk.http.Request
Sets the request's URI from the start line In this context, a URI is the path and query component of the URL for the resource.
setURIs(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the URI HeaderFields in this Headers object.
setUrl(String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField.Help
 
setValue(String) - Method in class com.pingidentity.pa.sdk.http.HeaderField
Sets the Value
setValues(String, List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values of the HeaderFields with the specified name.
setVary(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the Vary HeaderFields in this Headers object.
setXForwardedFor(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the X-Forwarded-For HeaderFields in this Headers object.
setXForwardedHost(List<String>) - Method in interface com.pingidentity.pa.sdk.http.Headers
Replaces all the values for the X-Forwarded-Host HeaderFields in this Headers object.
setXForwardedProto(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first X-Forwarded-Proto HeaderField.
setXFrameOptions(String) - Method in interface com.pingidentity.pa.sdk.http.Headers
Sets the value for the first X-Frame-Options HeaderField.
SimplePluginConfiguration - Class in com.pingidentity.pa.sdk.policy
Base class for use with PluginConfiguration
SimplePluginConfiguration() - Constructor for class com.pingidentity.pa.sdk.policy.SimplePluginConfiguration
 
SiteAuthenticator - Annotation Type in com.pingidentity.pa.sdk.siteauthenticator
SiteAuthenticatorInterceptor<T extends PluginConfiguration> - Interface in com.pingidentity.pa.sdk.siteauthenticator
A SiteAuthenticatorInterceptor is the runtime instantiation of a Site Authenticator defined in the Administrative API.
SiteAuthenticatorInterceptorBase<T extends PluginConfiguration> - Class in com.pingidentity.pa.sdk.siteauthenticator
A Base class designed to simplify implementing a SiteAuthenticatorInterceptor
SiteAuthenticatorInterceptorBase() - Constructor for class com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptorBase
 
SslData - Interface in com.pingidentity.pa.sdk.ssl
 
subField(String, String, ConfigurationType, Set<ConfigurationOption>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Add an individual subfield to the last Configuration field
subField(String, String, ConfigurationType) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Adds an individual subfield to the last ConfigurationField
subFields(List<ConfigurationField>) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the subfields on the last set ConfigurationField.
SWITCHING_PROTOCOLS - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 

T

TargetHost - Interface in com.pingidentity.pa.sdk.http
Representation of a hostname:port combination
TemplateRenderer - Interface in com.pingidentity.pa.sdk.util
Renders the templates defined in the conf/template/ directory of the PingAccess install.
TEMPORARY_REDIRECT - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
TEXT_HTML - Static variable in class com.pingidentity.pa.sdk.http.CommonMediaTypes
MediaType for text/html, using the UTF-8 Charset
TEXT_PLAIN - Static variable in class com.pingidentity.pa.sdk.http.CommonMediaTypes
MediaType for text/plain, using the UTF-8 Charset
TEXT_XML - Static variable in class com.pingidentity.pa.sdk.http.CommonMediaTypes
MediaType for text/xml, using the UTF-8 Charset
ThirdPartyServiceAccessor - Interface in com.pingidentity.pa.sdk.accessor.tps
A ConfigurationModelAccessor to access third-party services configured via the PingAccess Administrative API.
ThirdPartyServiceModel - Class in com.pingidentity.pa.sdk.accessor.tps
Represents a third-party service configured in the Administrative API To obtain access to the configuration contained in a ThirdPartyServiceModel, a plugin should define a field in its PluginConfiguration with a type of ThirdPartyServiceModel and configure the associated ConfigurationField to use a ConfigurationModelAccessor of ThirdPartyServiceAccessor.
ThirdPartyServiceModel(String, String) - Constructor for class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
toConfigurationFields() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Returns a list of ConfigurationFields for this ConfigurationBuilder
toFirstField() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Returns the first defined ConfigurationField
toHeaderField() - Method in class com.pingidentity.pa.sdk.http.SetCookie
Method to convert this to a HeaderField.
TOO_MANY_REQUESTS - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
toString() - Method in class com.pingidentity.pa.sdk.accessor.keypair.KeyPairModel
 
toString() - Method in class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
 
toString() - Method in interface com.pingidentity.pa.sdk.http.Body
A debugging function to provide a String representation of the body content.
toString() - Method in class com.pingidentity.pa.sdk.http.client.ClientRequest
Returns a String representation of this request.
toString() - Method in class com.pingidentity.pa.sdk.http.ExchangeProperty
 
toString() - Method in class com.pingidentity.pa.sdk.http.HeaderField
 
toString() - Method in class com.pingidentity.pa.sdk.http.HeaderName
 
toString() - Method in class com.pingidentity.pa.sdk.http.HttpStatus
 
toString() - Method in class com.pingidentity.pa.sdk.http.MediaType
 
toString() - Method in class com.pingidentity.pa.sdk.http.Method
 
toString() - Method in class com.pingidentity.pa.sdk.http.SetCookie
 
toString() - Method in class com.pingidentity.pa.sdk.localization.BasicLocalizedMessage
 
toString() - Method in class com.pingidentity.pa.sdk.localization.FixedMessage
 
toString() - Method in class com.pingidentity.pa.sdk.localization.ParameterizedLocalizedMessage
 
toString() - Method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerConfigurationImpl
 
TRACE - Static variable in class com.pingidentity.pa.sdk.http.Method
 
TrustedCertificateGroupAccessor - Interface in com.pingidentity.pa.sdk.accessor.certgroup
A ConfigurationModelAccessor to access certificates contained in a Trusted Certificate Group configured via the PingAccess Administrative API.
TrustedCertificateGroupModel - Class in com.pingidentity.pa.sdk.accessor.certgroup
Represents a trusted certificate group configured in the Administrative API.
TrustedCertificateGroupModel(String, String, Collection<X509Certificate>) - Constructor for class com.pingidentity.pa.sdk.accessor.certgroup.TrustedCertificateGroupModel
trustedCertificatesConfigurationField(String, String) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Defines a ConfigurationField of type ConfigurationType.SELECT and applies TrustedCertificateGroupAccessor as the DynamicOptions
type(ConfigurationType) - Method in class com.pingidentity.pa.sdk.ui.ConfigurationBuilder
Sets the Type value on the last ConfigurationField

U

UIElement - Annotation Type in com.pingidentity.pa.sdk.ui
Annotation to be applied to Fields.
UIElement.NONE - Class in com.pingidentity.pa.sdk.ui
A Class which defines NONE for annotations expecting a class.
UNAUTHORIZED - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
unauthorized() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "401 Unauthorized" status.
UNCHECKOUT - Static variable in class com.pingidentity.pa.sdk.http.Method
 
UNLINK - Static variable in class com.pingidentity.pa.sdk.http.Method
 
UNLOCK - Static variable in class com.pingidentity.pa.sdk.http.Method
 
UNPROCESSABLE_ENTITY - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
unprocessableEntity() - Static method in interface com.pingidentity.pa.sdk.http.ResponseBuilder
Creates a ResponseBuilder with a "422 Unprocessable Entity" status.
UNSUPPORTED_MEDIA_TYPE - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 
UPDATE - Static variable in class com.pingidentity.pa.sdk.http.Method
 
UPDATEREDIRECTREF - Static variable in class com.pingidentity.pa.sdk.http.Method
 
USE_PROXY - Static variable in class com.pingidentity.pa.sdk.http.HttpStatus
 

V

value(String) - Method in class com.pingidentity.pa.sdk.http.SetCookie
Sets the value
value - Variable in class com.pingidentity.pa.sdk.ui.ConfigurationDependentFieldOption
 
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.http.client.HttpClientException.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.interceptor.Outcome
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.localization.ErrorDescription
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.policy.ApplicationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.policy.PathPattern.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.policy.RuleInterceptorCategory
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.policy.RuleInterceptorSupportedDestination
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pingidentity.pa.sdk.ui.ConfigurationType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.pingidentity.pa.sdk.http.client.HttpClientException.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.interceptor.Outcome
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.localization.ErrorDescription
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.policy.ApplicationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.policy.PathPattern.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.policy.RuleInterceptorCategory
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.policy.RuleInterceptorSupportedDestination
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pingidentity.pa.sdk.ui.ConfigurationType
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_CONTROL - Static variable in class com.pingidentity.pa.sdk.http.Method
 

W

writeErrorResponse(Exchange) - Method in class com.pingidentity.pa.sdk.policy.error.LocalizedInternalServerErrorCallback
 
writeErrorResponse(Exchange) - Method in class com.pingidentity.pa.sdk.policy.error.OAuthPolicyErrorHandlingCallback
 
writeErrorResponse(Exchange) - Method in class com.pingidentity.pa.sdk.policy.error.RuleInterceptorErrorHandlingCallback
 
writeErrorResponse(Exchange) - Method in interface com.pingidentity.pa.sdk.policy.ErrorHandlingCallback
This method implements writing responses when errors are encountered.
A B C D E F G H I J K L M N O P R S T U V W 
Skip navigation links

Copyright 2019 Ping Identity Corp. All rights reserved.