A B C E G I P R S T V

A

Agent - Interface in com.pingidentity.pingaccess.agent.api

The Agent is the primary interface into the Agent API.

AGENT_SSL_CIPHERS - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

AGENT_SSL_PROTOCOLS - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

AgentConfiguration - Interface in com.pingidentity.pingaccess.agent.api.config

An interface representing the agent properties configuration.

AgentException - Exception in com.pingidentity.pingaccess.agent.api

An Exception thrown to indicate the Agent encountered an issue.

AgentException(String) - Constructor for exception com.pingidentity.pingaccess.agent.api.AgentException

AgentException(String, Throwable) - Constructor for exception com.pingidentity.pingaccess.agent.api.AgentException

AgentFactory - Class in com.pingidentity.pingaccess.agent.api

The factory used to get an Agent instance.

B

BaseAgentConfiguration - Class in com.pingidentity.pingaccess.agent.api.config

BaseAgentConfiguration provides an implementation of methods needed by concrete subclasses.

BaseAgentConfiguration() - Constructor for class com.pingidentity.pingaccess.agent.api.config.BaseAgentConfiguration

C

ClientRequest - Interface in com.pingidentity.pingaccess.agent.api.client.request

ClientRequest represents an HTTP request made by a client.

ClientResponse - Interface in com.pingidentity.pingaccess.agent.api.client.response

ClientResponse represents an HTTP response returned to the client.

com.pingidentity.pingaccess.agent.api - package com.pingidentity.pingaccess.agent.api

com.pingidentity.pingaccess.agent.api.client.request - package com.pingidentity.pingaccess.agent.api.client.request

com.pingidentity.pingaccess.agent.api.client.response - package com.pingidentity.pingaccess.agent.api.client.response

com.pingidentity.pingaccess.agent.api.config - package com.pingidentity.pingaccess.agent.api.config

com.pingidentity.pingaccess.agent.api.session - package com.pingidentity.pingaccess.agent.api.session

com.pingidentity.pingaccess.agent.api.ssl - package com.pingidentity.pingaccess.agent.api.ssl

com.pingidentity.pingaccess.agent.api.ssl.mgmt - package com.pingidentity.pingaccess.agent.api.ssl.mgmt

E

Exchange - Interface in com.pingidentity.pingaccess.agent.api.session

Represents the collective state of the Agent configuration and of various transactions in the Agent.

G

getAgent(AgentConfiguration, SecureConnectionManager) - Method in class com.pingidentity.pingaccess.agent.api.AgentFactory

Gets the Agent instance using the provided AgentConfiguration and SecureConnectionManager.

getAgent(AgentConfiguration) - Method in class com.pingidentity.pingaccess.agent.api.AgentFactory

Gets the Agent instance using the provided AgentConfiguration and the default StaticSecureConnectionManager initialized with StrictSecureConnection.

getAgentRequest() - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets the AgentRequest.

getAgentResponse() - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets the AgentResponse.

getBody() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the body of the client request.

getClientRequest() - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets the ClientRequest.

getClientResponse() - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets the ClientResponse.

getContentLengthAsLong() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the client request Content-Length.

getHeaders() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the request headers of the the client request.

getHostnameVerifier() - Method in interface com.pingidentity.pingaccess.agent.api.ssl.mgmt.SecureConnectionManager

Gets a HostnameVerifier.

getHostnameVerifier() - Method in class com.pingidentity.pingaccess.agent.api.ssl.mgmt.StaticSecureConnectionManager

getHostnameVerifier() - Method in interface com.pingidentity.pingaccess.agent.api.ssl.SecureConnection

Gets a HostnameVerifier.

getHostnameVerifier() - Method in class com.pingidentity.pingaccess.agent.api.ssl.StrictSecureConnection

getHostnameVerifier() - Method in class com.pingidentity.pingaccess.agent.api.ssl.SystemSecureConnection

getHostnameVerifier() - Method in class com.pingidentity.pingaccess.agent.api.ssl.TestSecureConnection

getInstance() - Static method in class com.pingidentity.pingaccess.agent.api.AgentFactory

Gets an instance of the AgentFactory.

getMethod() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the client request HTTP method.

getNormalizedRequestURI() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the decoded request URI of the client request.

getOutputStream() - Method in interface com.pingidentity.pingaccess.agent.api.client.response.ClientResponse

Gets the client response output stream.

getProperties() - Method in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

Gets the agent configuration properties.

getProperties() - Method in class com.pingidentity.pingaccess.agent.api.config.BaseAgentConfiguration

Gets the agent configuration properties.

getPropertyValue(String) - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets a key's property value.

getPropertyValues(String) - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets a key's property values.

getProtocol() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the client request HTTP protocol version.

getQueryString() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the client request query string.

getRawRequestURI() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the original request URI of the client request.

getRemoteAddr() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the client IP address.

getScheme() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the client HTTP request scheme.

getSecureConnectionManager() - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Gets a SecureConnectionManager.

getSSLContext(Exchange) - Method in interface com.pingidentity.pingaccess.agent.api.ssl.mgmt.SecureConnectionManager

Gets an SSLContext.

getSSLContext(Exchange) - Method in class com.pingidentity.pingaccess.agent.api.ssl.mgmt.StaticSecureConnectionManager

getSSLContext(Exchange) - Method in interface com.pingidentity.pingaccess.agent.api.ssl.SecureConnection

Gets an SSLContext.

getSSLContext(Exchange) - Method in class com.pingidentity.pingaccess.agent.api.ssl.SystemSecureConnection

I

isSetRequestedHeader() - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Identifies whether to request the resource from PingAccess.

P

PA_ENGINE_HOSTNAME - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PA_ENGINE_PORT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PA_ENGINE_SCHEME - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PA_ENGINE_SECRET - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PA_ENGINE_TRUST_CERTS - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PA_ENGINE_USERNAME - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_DISABLED - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_EVICTION_INTERVAL - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_EVICTION_INTERVAL_DEFAULT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_EVICTION_TOKEN_SEARCH_LIMIT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_EVICTION_TOKEN_SEARCH_LIMIT_DEFAULT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_HIGH_WATER_MARK - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_HIGH_WATER_MARK_DEFAULT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_HIGH_WATER_MARK_EVICTION_INTERVAL - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_HIGH_WATER_MARK_EVICTION_INTERVAL_DEFAULT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_MAX_TOKENS - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_MAX_TOKENS_DEFAULT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAA_CACHE_TOKEN_CACHE_MAX_SIZE - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAAP_CONNECT_TIMEOUT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAAP_DNS_IPV4_ONLY - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAAP_MAX_CONNECTIONS - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

PAAP_TIMEOUT - Static variable in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

paapAppendHeader(String, String) - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Sets a vnd-pi-append-req-header PingAccess Agent Protocol specification header.

paapAppendHeader(String, String) - Method in interface com.pingidentity.pingaccess.agent.api.client.response.ClientResponse

Sets a vnd-pi-append-resp-header PingAccess Agent Protocol specification header.

paapGetSubject() - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Gets the vnd-pi-sub PingAccess Agent Protocol specification subject.

paapRemoveHeader(String) - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Sets a header to be removed per the PingAccess Agent Protocol specification.

paapRemoveHeader(String) - Method in interface com.pingidentity.pingaccess.agent.api.client.response.ClientResponse

Specifies a header to be removed per the PingAccess Agent Protocol specification.

paapSetHeader(String, String) - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Sets a vnd-pi-set-req-header PingAccess Agent Protocol specification header.

paapSetHeader(String, String) - Method in interface com.pingidentity.pingaccess.agent.api.client.response.ClientResponse

Sets a vnd-pi-set-resp-header PingAccess Agent Protocol specification header.

paapSetSubject(String) - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Sets the vnd-pi-sub PingAccess Agent Protocol specification subject.

paapSetVar(String, String) - Method in interface com.pingidentity.pingaccess.agent.api.client.request.ClientRequest

Sets a vnd-pi-set-req-var PingAccess Agent Protocol specification variable.

R

run(ClientRequest, ClientResponse) - Method in interface com.pingidentity.pingaccess.agent.api.Agent

Runs the Agent using ClientRequest and ClientResponse

S

SecureConnection - Interface in com.pingidentity.pingaccess.agent.api.ssl

An interface providing access to an SSLContext and a HostnameVerifier used to make HTTPS requests to PingAccess to retrieve policy decisions.

SecureConnectionManager - Interface in com.pingidentity.pingaccess.agent.api.ssl.mgmt

Represents a manager of a SecureConnection instance

setAgentRequest(AgentRequest) - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Sets the AgentRequest.

setAgentResponse(AgentResponse) - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Sets the AgentResponse.

setRequestedHeader(boolean) - Method in interface com.pingidentity.pingaccess.agent.api.session.Exchange

Sets the requested header in the Agent Request to PingAccess.

setStatus(int) - Method in interface com.pingidentity.pingaccess.agent.api.client.response.ClientResponse

Sets the HTTP status code returned from PingAccess.

StaticAgentConfiguration - Class in com.pingidentity.pingaccess.agent.api.config

An implementation of AgentConfiguration representing the agent properties configuration.

StaticAgentConfiguration(Properties) - Constructor for class com.pingidentity.pingaccess.agent.api.config.StaticAgentConfiguration

StaticSecureConnectionManager - Class in com.pingidentity.pingaccess.agent.api.ssl.mgmt

StaticSecureConnectionManager is an implementation of SecureConnectionManager which provides static access to a SecureConnection at runtime.

StaticSecureConnectionManager(SecureConnection) - Constructor for class com.pingidentity.pingaccess.agent.api.ssl.mgmt.StaticSecureConnectionManager

StrictSecureConnection - Class in com.pingidentity.pingaccess.agent.api.ssl

StrictSecureConnection is an implementation of SecureConnection which provides strict SSL certificate validation of the PingAccess agent listener certificate using the trust store certificate property in the agent properties configuration.

StrictSecureConnection() - Constructor for class com.pingidentity.pingaccess.agent.api.ssl.StrictSecureConnection

SystemSecureConnection - Class in com.pingidentity.pingaccess.agent.api.ssl

SystemSecureConnection is an implementation of SecureConnection which provides strict SSL certificate validation of the PingAccess agent listener certificate using a certificate imported into the Java cacerts keystore.

SystemSecureConnection() - Constructor for class com.pingidentity.pingaccess.agent.api.ssl.SystemSecureConnection

T

TestSecureConnection - Class in com.pingidentity.pingaccess.agent.api.ssl

An implementation of the SecureConnection designed for test purposes only.

TestSecureConnection() - Constructor for class com.pingidentity.pingaccess.agent.api.ssl.TestSecureConnection

V

validate() - Method in interface com.pingidentity.pingaccess.agent.api.config.AgentConfiguration

Validates the agent configuration properties.

validate() - Method in class com.pingidentity.pingaccess.agent.api.config.BaseAgentConfiguration

Validates the agent configuration properties.

A B C E G I P R S T V