- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getConfigurationFields() - Static method in class com.pingidentity.pa.sdk.policy.config.ErrorHandlerUtil
-
- getConfigurationModelAccessor(Class<T>) - Method in interface com.pingidentity.pa.sdk.accessor.ConfigurationModelAccessorFactory
-
- getConnection() - Method in interface com.pingidentity.pa.sdk.http.Headers
-
- 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
-
- 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
-
- 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
-
- getDate() - Method in interface com.pingidentity.pa.sdk.http.Headers
-
- getDefaultValue() - Method in class com.pingidentity.pa.sdk.ui.ConfigurationField
-
- getDependantFieldAccessor(Class<T>) - Method in interface com.pingidentity.pa.sdk.accessor.DependantFieldAccessorFactory
-
- 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
-
- getErrorHandlingCallback() - Method in interface com.pingidentity.pa.sdk.policy.RuleInterceptor
-
- 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
-
- getHeaderName() - Method in class com.pingidentity.pa.sdk.http.HeaderField
-
- 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
-
- 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
-
- getLocation() - Method in interface com.pingidentity.pa.sdk.http.Headers
-
- getMappedSubject() - Method in interface com.pingidentity.pa.sdk.identity.Identity
-
- 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
-
- 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
-
- getPathPrefixes() - Method in interface com.pingidentity.pa.sdk.policy.Resource
-
- 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
-
- 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
-
- getRequestUri() - Method in class com.pingidentity.pa.sdk.accessor.tps.ThirdPartyServiceModel
-
- 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
-
- 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.
- getSameSite() - Method in class com.pingidentity.pa.sdk.http.SetCookie
-
Retrieves the SameSite cookie attribute value
- 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
-
- 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
-
- 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
-
- getStatusMessage() - Method in interface com.pingidentity.pa.sdk.http.Response
-
- 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
-
- 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
-
- 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
-
- 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
-
- getXForwardedHost() - Method in interface com.pingidentity.pa.sdk.http.Headers
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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.
- 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
-
- 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.
- matches(MediaType) - Method in class com.pingidentity.pa.sdk.http.MediaType
-
Checks that the specified
MediaType matches both the primary type and subtype of this
MediaType.
- matchesBaseType(String) - Method in class com.pingidentity.pa.sdk.http.MediaType
-
- matchesBaseType(MediaType) - Method in class com.pingidentity.pa.sdk.http.MediaType
-
- 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
- MediaType(String, String, Map<String, String>, boolean) - 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
-
- 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
-