- ANONYMOUS - Static variable in class com.nimbusds.common.id.AuthzId
-
Anonymous user identity.
- API_TOKEN_PROPERTY_NAME - Static variable in class com.nimbusds.common.servlet.MonitorServlet
-
The property name for the API access token.
- apiKey - Variable in class com.nimbusds.common.config.WebServiceDetails
-
Optional API key to include with requests to the web service,
null if none.
- append(T) - Method in interface com.nimbusds.common.appendable.Appendable
-
Appends the specified element.
- append(T) - Method in class com.nimbusds.common.appendable.JSONArrayWriter
-
- append(T) - Method in class com.nimbusds.common.appendable.JSONObjectWriter
-
- Appendable<T> - Interface in com.nimbusds.common.appendable
-
Generic appendable interface.
- apply(HttpServletResponse) - Method in class com.nimbusds.common.jsonrpc2.Banner
-
Applies this banner to the specified HTTP servlet response.
- apply(String) - Method in class com.nimbusds.common.ldap.FilterTemplate
-
Applies the specified parameter to this filter template and returns
the resulting LDAP filter string.
- apply(HttpServletResponse) - Method in class com.nimbusds.common.oauth2.BasicAccessTokenValidator.ErrorResponse
-
Applies this error response to the specified HTTP servlet
response.
- AttributeMapper - Class in com.nimbusds.common.ldap
-
LDAP attribute mapper.
- AttributeMapper(Map<String, Object>) - Constructor for class com.nimbusds.common.ldap.AttributeMapper
-
Creates a new LDAP attribute mapper.
- AttributesForRetrieval - Class in com.nimbusds.common.ldap
-
Specifies a set of directory attributes for retrieval.
- AttributesForRetrieval() - Constructor for class com.nimbusds.common.ldap.AttributesForRetrieval
-
Creates a default specification of attributes for retrieval which is
retrieve all user attributes as UTF-8 text.
- AuthzId - Class in com.nimbusds.common.id
-
Represents a SASL authorisation identity, as specified in RFC 4513, section
5.2.1.8.
- AuthzId(DN) - Constructor for class com.nimbusds.common.id.AuthzId
-
Creates a new authorisation identity from the specified DN.
- AuthzId(Username) - Constructor for class com.nimbusds.common.id.AuthzId
-
Creates a new authorisation identity from the specified username.
- AuthzId.IdentityType - Enum in com.nimbusds.common.id
-
The identity data types.
- AuthzIdResolver - Class in com.nimbusds.common.id
-
Resolves the authorisation identity (authzId) associated with a bind (auth)
request.
- CHARSET - Static variable in class com.nimbusds.common.util.URLUtility
-
The default character set.
- check() - Method in class com.nimbusds.common.ldap.LDAPHealthCheck
-
- CID - Class in com.nimbusds.common.id
-
Represents a secure immutable connection identifier (CID).
- CID() - Constructor for class com.nimbusds.common.id.CID
-
Creates a new unique connection identifier (CID) based on a secure
randomly generated 256-bit number, Base64URL-encoded.
- CID(String) - Constructor for class com.nimbusds.common.id.CID
-
Creates a new connection identifier (CID) from the specified string.
- com.nimbusds.common.appendable - package com.nimbusds.common.appendable
-
Appendable pattern classes.
- com.nimbusds.common.config - package com.nimbusds.common.config
-
Configuration classes.
- com.nimbusds.common.id - package com.nimbusds.common.id
-
Identifier and identity classes.
- com.nimbusds.common.jsonrpc2 - package com.nimbusds.common.jsonrpc2
-
JSON-RPC 2.0 related classes.
- com.nimbusds.common.ldap - package com.nimbusds.common.ldap
-
LDAP directory related classes.
- com.nimbusds.common.monitor - package com.nimbusds.common.monitor
-
Common monitor classes for Dropwizard metrics and health checks.
- com.nimbusds.common.oauth2 - package com.nimbusds.common.oauth2
-
OAuth 2.0 utility classes.
- com.nimbusds.common.servlet - package com.nimbusds.common.servlet
-
Shared servlet classes and utilities.
- com.nimbusds.common.store - package com.nimbusds.common.store
-
Common store interfaces and classes.
- com.nimbusds.common.util - package com.nimbusds.common.util
-
Generic utilities.
- compareTo(Identifier) - Method in class com.nimbusds.common.id.BaseIdentifier
-
- composeLogMessage(HttpServletRequest) - Static method in class com.nimbusds.common.servlet.ServletLogUtility
-
Composes a log message with the method, the client IP address, CORS
origin (if any and a CORS Filter is configured) and the security
client certificate principal (if any) of an HTTP request.
- composeMessage(String, String, String[]) - Static method in class com.nimbusds.common.jsonrpc2.Banner
-
Composes a banner message.
- CONFIG_CTX_PARAMETER_NAME - Static variable in class com.nimbusds.common.servlet.MonitorLauncher
-
The name of the servlet context parameter that specifies the
configuration file location.
- ConfigurationException - Exception in com.nimbusds.common.config
-
Thrown to indicate a configuration exception.
- ConfigurationException(String) - Constructor for exception com.nimbusds.common.config.ConfigurationException
-
Creates a new configuration exception with the specified message.
- ConfigurationException(String, Throwable) - Constructor for exception com.nimbusds.common.config.ConfigurationException
-
Creates a new configuration exception with the specified message and
cause.
- connectionMaxAge - Variable in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
The maximum time in milliseconds that a connection in this pool may
be established before it should be closed and replaced with another
connection.
- connectionPoolMaxWaitTime - Variable in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
The maximum length of time in milliseconds to wait for a connection
to become available when trying to obtain a connection from the
pool.
- connectionPoolSize - Variable in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
The target connection pool size.
- connectTimeout - Variable in class com.nimbusds.common.config.LDAPServerDetails
-
The timeout in milliseconds for LDAP connect requests.
- connectTimeout - Variable in class com.nimbusds.common.config.WebServiceDetails
-
Specifies an HTTP connect timeout for web service requests, in
milliseconds.
- content - Variable in class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
The initial directory information tree, supplied in a single
LDIF file.
- contextDestroyed(ServletContextEvent) - Method in class com.nimbusds.common.ldap.ExampleDirectory
-
Handler for servlet context shutdown events.
- contextDestroyed(ServletContextEvent) - Method in class com.nimbusds.common.servlet.InfinispanLauncher
-
Handler for servlet context shutdown events.
- contextDestroyed(ServletContextEvent) - Method in class com.nimbusds.common.servlet.MonitorLauncher
-
- contextInitialized(ServletContextEvent) - Method in class com.nimbusds.common.ldap.ExampleDirectory
-
Handler for servlet context startup events.
- contextInitialized(ServletContextEvent) - Method in class com.nimbusds.common.servlet.InfinispanLauncher
-
Handler for servlet context startup events; configures and launches
an Infinispan cache manager using the configuration file specified
in the servlet context parameter infinispan.configurationFile.
- contextInitialized(ServletContextEvent) - Method in class com.nimbusds.common.servlet.MonitorLauncher
-
- convertMapKeysToLowerCase(Map<String, Object>) - Static method in class com.nimbusds.common.util.MapUtility
-
Returns a copy of the specified map with all string keys converted to
lower case.
- create(LDAPURL[], ServerSelectionAlgorithm, SocketFactory, LDAPConnectionOptions) - Static method in class com.nimbusds.common.ldap.LDAPServerSetFactory
-
Creates an LDAP server set from the specified configuration
parameters.
- createLDAPConnection(String, int, LDAPConnectionSecurity, int, boolean) - Method in class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Creates a new LDAP connection to the specified directory server.
- createLDAPConnection(ServerSet, LDAPConnectionSecurity, boolean) - Method in class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Creates a new LDAP connection to the specified directory server set.
- createLDAPConnection() - Method in class com.nimbusds.common.ldap.PresetLDAPConnectionFactory
-
Creates a new LDAP connection to the preset directory server.
- createLDAPConnectionPool() - Method in class com.nimbusds.common.ldap.LDAPConnectionPoolFactory
-
Creates a new LDAP connection pool.
- CustomKeyStoreConfiguration - Class in com.nimbusds.common.config
-
Details of a custom key store for client X.509 certificates to be presented
to a remote server.
- CustomKeyStoreConfiguration(String, Properties) - Constructor for class com.nimbusds.common.config.CustomKeyStoreConfiguration
-
Creates a new custom key store configuration from the specified
properties.
- CustomTrustStoreConfiguration - Class in com.nimbusds.common.config
-
Details of a custom trust store for remote server X.509 certificates.
- CustomTrustStoreConfiguration(String, Properties) - Constructor for class com.nimbusds.common.config.CustomTrustStoreConfiguration
-
Creates a new custom trust store configuration from the specified
properties.
- DEFAULT_BYTE_LENGTH - Static variable in class com.nimbusds.common.id.BaseIdentifier
-
The default byte length of generated identifiers.
- DEFAULT_CONNECT_TIMEOUT - Static variable in class com.nimbusds.common.config.LDAPServerDetails
-
The default timeout in milliseconds for LDAP connect requests.
- DEFAULT_CONNECT_TIMEOUT - Static variable in class com.nimbusds.common.config.WebServiceDetails
-
The default HTTP connect timeout for web service requests (disabled).
- DEFAULT_CONNECTION_MAX_AGE - Static variable in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
The default maximum connection time.
- DEFAULT_CONNECTION_POOL_MAX_WAIT_TIME - Static variable in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
The default connection pool maximum wait time, in milliseconds.
- DEFAULT_CONNECTION_POOL_SIZE - Static variable in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
The default target connection pool size.
- DEFAULT_ENABLE - Static variable in class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
The default enable policy.
- DEFAULT_EXPOSE_EXCEPTIONS - Static variable in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
The default expose exceptions policy.
- DEFAULT_LDAP_SERVER - Static variable in class com.nimbusds.common.config.Json2LdapDetails
-
The default LDAP server use.
- DEFAULT_PORT - Static variable in class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
The default port number.
- DEFAULT_READ_TIMEOUT - Static variable in class com.nimbusds.common.config.WebServiceDetails
-
The default HTTP read timeout for web service requests (disabled).
- DEFAULT_REPORT_REQUEST_PROC_TIME - Static variable in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
The default request processing time reporting.
- DEFAULT_RESPONSE_CONTENT_TYPE - Static variable in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
The default response content type.
- DEFAULT_SECURITY - Static variable in class com.nimbusds.common.config.LDAPServerDetails
-
The default LDAP connection security.
- DEFAULT_SELECTION_ALGORITHM - Static variable in class com.nimbusds.common.config.LDAPServerDetails
-
The default server selection algorithm.
- DEFAULT_SELF_SIGNED_CERT_TRUST - Static variable in class com.nimbusds.common.config.WebServiceDetails
-
The default self-signed certificate policy.
- DEFAULT_SELF_SIGNED_CERTS_TRUST - Static variable in class com.nimbusds.common.config.LDAPServerDetails
-
The default trust for self-signed certificates.
- destroy() - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2Servlet
-
Called at servlet shutdown.
- detect() - Method in class com.nimbusds.common.jsonrpc2.WsDetector
-
Detects the JSON-RPC 2.0 web service name and version.
- DirectoryProtocol - Enum in com.nimbusds.common.ldap
-
Enumeration of the protocols for directory access.
- DirectoryUser - Class in com.nimbusds.common.config
-
Directory user, with DN and password.
- DirectoryUser(String, Properties) - Constructor for class com.nimbusds.common.config.DirectoryUser
-
Creates a new directory user from the specified properties.
- DirectoryUser(DN, String) - Constructor for class com.nimbusds.common.config.DirectoryUser
-
Creates a new directory user.
- dn - Variable in class com.nimbusds.common.config.DirectoryUser
-
The distinguished name (DN) of the directory user DN.
- DNIdentity - Class in com.nimbusds.common.id
-
Represents a distinguished name (DN) identity.
- DNIdentity(DN) - Constructor for class com.nimbusds.common.id.DNIdentity
-
Creates a new distinguished name (DN) identity.
- doGet(HttpServletRequest, HttpServletResponse) - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2Servlet
-
Outputs a simple text/plain banner message that identifies the
Connect2id web service name/version and lists the supported JSON-RPC
2.0 requests.
- doGet(HttpServletRequest, HttpServletResponse) - Method in class com.nimbusds.common.servlet.MonitorServlet
-
- doPost(HttpServletRequest, HttpServletResponse) - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2Servlet
-
Receives JSON-RPC 2.0 requests for the Connect2id service by means
of HTTP POST.
- dumpObjectClassDefinition(LDAPConnection, String) - Static method in class com.nimbusds.common.ldap.SchemaUtils
-
Returns the schema definition for the specified object class, in the
format described in RFC 4512 section 4.1.1.
- enable - Variable in class com.nimbusds.common.config.CustomKeyStoreConfiguration
-
If true a custom key store file must be used for the client
X.509 certificates to be presented to the remote server (if such
authentication is required).
- enable - Variable in class com.nimbusds.common.config.CustomTrustStoreConfiguration
-
If true a custom trust store file must be used to determine
the acceptable security certificates presented by the remote server.
- enable - Variable in class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
If true the example directory server must be
enabled.
- ENABLE_JMX_PROPERTY_NAME - Static variable in class com.nimbusds.common.servlet.MonitorLauncher
-
The property name for the enable JMX switch.
- ensureSuccess(LDAPResult) - Static method in class com.nimbusds.common.ldap.LDAPExceptionUtils
-
Throws a JSON-RPC 2.0 error with corresponding code and message if
the specified LDAP result indicates failure.
- equals(Object) - Method in class com.nimbusds.common.id.AuthzId
-
- equals(Object) - Method in class com.nimbusds.common.id.BaseIdentifier
-
Overrides Object.equals().
- equals(Object) - Method in class com.nimbusds.common.id.CID
-
- equals(Object) - Method in class com.nimbusds.common.id.DNIdentity
-
- equals(Object) - Method in class com.nimbusds.common.id.SID
-
Overrides Object.equals().
- equals(Object) - Method in class com.nimbusds.common.id.UID
-
- equals(Object) - Method in class com.nimbusds.common.id.Username
-
- ExampleDirectory - Class in com.nimbusds.common.ldap
-
Example in-memory LDAP directory server for demonstration and testing
purposes.
- ExampleDirectory() - Constructor for class com.nimbusds.common.ldap.ExampleDirectory
-
- ExampleDirectory.Configuration - Class in com.nimbusds.common.ldap
-
The example directory server configuration.
- ExampleDirectory.Configuration(Properties) - Constructor for class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
Creates a new example directory server configuration from the
specified properties.
- exposeExceptions - Variable in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
If true the web service will expose exception details to
clients in the JSON-RPC 2.0 error "data" field.
- extractKey(T) - Method in interface com.nimbusds.common.appendable.KeyExtractor
-
Extracts or determines a JSON object key from the specified object.
- getAccessToken() - Method in class com.nimbusds.common.oauth2.BasicAccessTokenValidator
-
Returns the Bearer access token.
- getAPIKey() - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2ServiceConnector
-
Gets the optional API key for service access.
- getBaseURL(URL) - Static method in class com.nimbusds.common.util.URLUtility
-
Gets the base part (protocol, host, port and path) of the specified
URL.
- getBinaryAttributes() - Method in class com.nimbusds.common.ldap.AttributesForRetrieval
-
Gets the names of the attributes to retrieve as binary (Base64
encoded).
- getCauseType() - Method in exception com.nimbusds.common.ldap.LDAPConnectionException
-
Gets the cause type.
- getCustomKeyStoreConfiguration() - Method in class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Gets the custom key store configuration.
- getCustomTrustStoreConfiguration() - Method in class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Gets the custom trust store configuration.
- getDN() - Method in class com.nimbusds.common.id.AuthzId
-
Gets the identity DN.
- getDN() - Method in class com.nimbusds.common.id.DNIdentity
-
Gets the distinguished name (DN) value.
- getHandledJSONRPC2Methods() - Method in class com.nimbusds.common.jsonrpc2.Banner
-
Gets the handled JSON-RPC 2.0 methods.
- getHealthCheckRegistry() - Static method in class com.nimbusds.common.monitor.MonitorRegistries
-
Returns the singleton shared registry for health check instances.
- getId() - Method in class com.nimbusds.common.id.IdentifierExternalizer
-
- getIdentityType() - Method in class com.nimbusds.common.id.AuthzId
-
Gets the identity type.
- getLDAPAttributeName(String) - Method in class com.nimbusds.common.ldap.AttributeMapper
-
Gets the name of the LDAP attribute in the transformation map that
matches the specified JSON object member key.
- getLDAPAttributeNames() - Method in class com.nimbusds.common.ldap.AttributeMapper
-
Gets the names of the LDAP attributes in the transformation map.
- getLDAPAttributeNames(List<String>) - Method in class com.nimbusds.common.ldap.AttributeMapper
-
Gets the names of the LDAP attributes in the transformation map that
match the specified JSON object member keys.
- getLDAPServerDetails() - Method in class com.nimbusds.common.ldap.PresetLDAPConnectionFactory
-
Gets the LDAP server details.
- getMetricRegistry() - Static method in class com.nimbusds.common.monitor.MonitorRegistries
-
Returns the singleton shared registry for metric instances.
- getMetrics() - Method in class com.nimbusds.common.ldap.LDAPConnectionPoolMetrics
-
- getName() - Method in class com.nimbusds.common.jsonrpc2.WsInfo
-
Gets the web service name.
- getNextRequestID() - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2ServiceConnector
-
Gets the next JSON-RPC 2.0 request ID from the atomic counter.
- getPlaceholder() - Method in class com.nimbusds.common.ldap.FilterTemplate
-
Gets the placeholder.
- getProperties(ServletContext, String, Logger) - Static method in class com.nimbusds.common.servlet.ResourceRetriever
-
Gets the java.util.Properties in the specified servlet
context web.xml init parameter location.
- getProperties(ServletConfig, String, Logger) - Static method in class com.nimbusds.common.servlet.ResourceRetriever
-
Gets the java.util.Properties in the specified servlet
web.xml init parameter location.
- getSession() - Method in class com.nimbusds.common.jsonrpc2.WsDetector
-
Gets the client session associated with this JSON-RPC 2.0 web service
detected.
- getSocketFactory(LDAPConnectionSecurity, CustomTrustStoreConfiguration, CustomKeyStoreConfiguration, boolean) - Static method in class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Creates a new socket factory according to the specified LDAP
connection security settings.
- getSpec() - Method in class com.nimbusds.common.ldap.AttributesForRetrieval
-
Retrieves the specification of the attributes (UTF-8 text and binary)
for retrieval for an LDAP get entry/search request.
- getStream(ServletContext, String, Logger) - Static method in class com.nimbusds.common.servlet.ResourceRetriever
-
Gets the resource in the specified servlet context web.xml
init parameter location.
- getStream(ServletConfig, String, Logger) - Static method in class com.nimbusds.common.servlet.ResourceRetriever
-
Gets the resource in the specified servlet web.xml init
parameter location.
- getString(ServletContext, String, Logger) - Static method in class com.nimbusds.common.servlet.ResourceRetriever
-
Gets the resource in the specified servlet context web.xml
init parameter location.
- getTemplate() - Method in class com.nimbusds.common.ldap.FilterTemplate
-
Gets the template.
- getTypeClasses() - Method in class com.nimbusds.common.id.IdentifierExternalizer
-
- getUsername() - Method in class com.nimbusds.common.id.AuthzId
-
Gets the identity username.
- getVersion() - Method in class com.nimbusds.common.jsonrpc2.WsInfo
-
Gets the web service version.
- getWsInfo() - Method in class com.nimbusds.common.jsonrpc2.LoggingWsDetector
-
Returns the detected web service name and version.
- getWsName() - Method in class com.nimbusds.common.jsonrpc2.Banner
-
Gets the web service name.
- getWsVersion() - Method in class com.nimbusds.common.jsonrpc2.Banner
-
Gets the web service version and build date.
- Identifier - Interface in com.nimbusds.common.id
-
Marker interface for identifiers (IDs) used in Connect2id software.
- IdentifierExternalizer - Class in com.nimbusds.common.id
-
Identifier externalisers, required by Infinispan marshalling.
- IdentifierExternalizer() - Constructor for class com.nimbusds.common.id.IdentifierExternalizer
-
- Identity - Interface in com.nimbusds.common.id
-
Marker interface for user and other identities used in Connect2id software.
- INFINISPAN_CONFIG_FILENAME - Static variable in class com.nimbusds.common.servlet.InfinispanLauncher
-
The name of the Infinispan configuration filename.
- INFINISPAN_CTX_ATTRIBUTE_NAME - Static variable in class com.nimbusds.common.servlet.InfinispanLauncher
-
The name of the servlet context attribute for the launched
Infinispan cache manager.
- InfinispanLauncher - Class in com.nimbusds.common.servlet
-
Configures and launches an Infinispan cache manager at servlet context
startup.
- InfinispanLauncher() - Constructor for class com.nimbusds.common.servlet.InfinispanLauncher
-
- InfinispanLauncher.StartLogger - Class in com.nimbusds.common.servlet
-
Logs Infinispan status and network topology after startup.
- InfinispanLauncher.StartLogger(Date) - Constructor for class com.nimbusds.common.servlet.InfinispanLauncher.StartLogger
-
Creates a new Infinispan startup logger.
- InfinispanLauncher.StopLogger - Class in com.nimbusds.common.servlet
-
Logs Infinispan stop.
- InfinispanLauncher.StopLogger(Date) - Constructor for class com.nimbusds.common.servlet.InfinispanLauncher.StopLogger
-
Creates a new Infinispan stop logger.
- init(WsInfo) - Method in class com.nimbusds.common.jsonrpc2.WsInfoRequestHandler
-
Initialises this WS info request handler.
- init(ServletConfig) - Method in class com.nimbusds.common.servlet.MonitorServlet
-
- initSecureConnectionContext(CustomTrustStoreConfiguration, CustomKeyStoreConfiguration, boolean) - Static method in class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Initialises the context for a secure LDAP connection by creating the
required TLS/SSL trust and key managers.
- INVALID_BEARER_TOKEN - Static variable in class com.nimbusds.common.oauth2.BasicAccessTokenValidator
-
Error response: Invalid OAuth 2.0 Bearer access token.
- isLegal(String) - Static method in class com.nimbusds.common.id.Username
-
Checks whether the specified username value is legal.
- isLegal(String, Pattern) - Static method in class com.nimbusds.common.id.Username
-
Checks whether the specified username value is legal.
- isLocal() - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2ServiceConnector
-
Returns true if the connector is to a local service
instance.
- isRemote() - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2ServiceConnector
-
Returns false if the connector is to a remote (HTTP) service
instance.
- LDAPConnectionException - Exception in com.nimbusds.common.ldap
-
LDAP connection exception.
- LDAPConnectionException(String) - Constructor for exception com.nimbusds.common.ldap.LDAPConnectionException
-
Creates a new LDAP connection exception, with no specific cause
type.
- LDAPConnectionException(String, LDAPConnectionException.CauseType) - Constructor for exception com.nimbusds.common.ldap.LDAPConnectionException
-
Creates a new LDAP connection exception.
- LDAPConnectionException(String, LDAPConnectionException.CauseType, Throwable) - Constructor for exception com.nimbusds.common.ldap.LDAPConnectionException
-
Creates a new LDAP connection exception.
- LDAPConnectionException.CauseType - Enum in com.nimbusds.common.ldap
-
Enumeration of LDAP connection exception cause types.
- LDAPConnectionFactory - Class in com.nimbusds.common.ldap
-
Factory for establishing LDAP connections to a directory server.
- LDAPConnectionFactory(CustomTrustStoreConfiguration, CustomKeyStoreConfiguration) - Constructor for class com.nimbusds.common.ldap.LDAPConnectionFactory
-
Creates a new LDAP connection factory.
- LDAPConnectionPoolFactory - Class in com.nimbusds.common.ldap
-
Factory for establishing LDAP connection pools to a directory server.
- LDAPConnectionPoolFactory(LDAPServerConnectionPoolDetails, CustomTrustStoreConfiguration, CustomKeyStoreConfiguration, DirectoryUser) - Constructor for class com.nimbusds.common.ldap.LDAPConnectionPoolFactory
-
Creates a LDAP connection pool factory.
- LDAPConnectionPoolMetrics - Class in com.nimbusds.common.ldap
-
LDAP connection metrics.
- LDAPConnectionPoolMetrics(LDAPConnectionPool, String) - Constructor for class com.nimbusds.common.ldap.LDAPConnectionPoolMetrics
-
Creates a new LDAP connection metrics.
- LDAPConnectionSecurity - Enum in com.nimbusds.common.ldap
-
Enumeration of the transport layer security types for LDAP connections.
- LDAPControlRequestParser - Class in com.nimbusds.common.ldap
-
LDAP control request parser.
- LDAPExceptionUtils - Class in com.nimbusds.common.ldap
-
LDAP exception utilities.
- LDAPHealthCheck - Class in com.nimbusds.common.ldap
-
Simple LDAP connection (individual or pool) health check.
- LDAPHealthCheck(LDAPInterface, DN, Logger) - Constructor for class com.nimbusds.common.ldap.LDAPHealthCheck
-
Creates a new LDAP connection pool health check.
- LDAPServerConnectionPoolDetails - Class in com.nimbusds.common.config
-
LDAP server connection pool details.
- LDAPServerConnectionPoolDetails(String, Properties) - Constructor for class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
Creates a new LDAP server connection pool details instance from the
specified properties.
- LDAPServerConnectionPoolDetails(String, Properties, boolean) - Constructor for class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
Creates a new LDAP server connection pool details instance from the
specified properties.
- LDAPServerDetails - Class in com.nimbusds.common.config
-
LDAP server connect details.
- LDAPServerDetails(LDAPURL, LDAPConnectionSecurity, int, boolean) - Constructor for class com.nimbusds.common.config.LDAPServerDetails
-
Creates a new LDAP server details instance.
- LDAPServerDetails(LDAPURL[], ServerSelectionAlgorithm, LDAPConnectionSecurity, int, boolean) - Constructor for class com.nimbusds.common.config.LDAPServerDetails
-
Creates a new LDAP server details instance.
- LDAPServerDetails(String, Properties) - Constructor for class com.nimbusds.common.config.LDAPServerDetails
-
Creates a new LDAP server details instance from the specified
properties.
- LDAPServerDetails(String, Properties, boolean) - Constructor for class com.nimbusds.common.config.LDAPServerDetails
-
Creates a new LDAP server details instance from the specified
properties.
- LDAPServerSetFactory - Class in com.nimbusds.common.ldap
-
LDAP server set factory.
- LDIFResultFormatter - Class in com.nimbusds.common.ldap
-
Static methods to format complex LDAP result structures as LDIF strings.
- LEGAL_USERNAME_RE - Static variable in class com.nimbusds.common.id.Username
-
The regular expression string used to match legal usernames.
- log() - Method in class com.nimbusds.common.config.CustomKeyStoreConfiguration
-
Logs the configuration details at INFO level using Log4j.
- log() - Method in class com.nimbusds.common.config.CustomTrustStoreConfiguration
-
Logs the configuration details at INFO level using Log4j.
- log() - Method in class com.nimbusds.common.config.DirectoryUser
-
Logs the configuration details at INFO level.
- log() - Method in class com.nimbusds.common.config.Json2LdapDetails
-
Logs the configuration details at INFO level.
- log() - Method in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
Logs the configuration details at INFO level.
- log() - Method in class com.nimbusds.common.config.LDAPServerConnectionPoolDetails
-
Logs the configuration details at INFO level.
- log() - Method in class com.nimbusds.common.config.LDAPServerDetails
-
Logs the configuration details at INFO level.
- log() - Method in interface com.nimbusds.common.config.LoggableConfiguration
-
Logs the configuration properties at INFO level.
- log() - Method in class com.nimbusds.common.config.WebServiceDetails
-
Logs the configuration details at INFO level.
- log(JSONRPC2Request, JSONRPC2Response, String) - Static method in class com.nimbusds.common.jsonrpc2.JSONRPC2LogUtility
-
Logs (at INFO level) the name of the JSON-RPC 2.0 request and the
resulting response (success or error code + message).
- log(JSONRPC2Request, JSONRPC2Response) - Static method in class com.nimbusds.common.jsonrpc2.JSONRPC2LogUtility
-
Logs (at INFO level) the name of the JSON-RPC 2.0 request and the
resulting response (success or error code + message).
- log(HttpServletRequest) - Static method in class com.nimbusds.common.servlet.ServletLogUtility
-
Logs (at INFO level) the method, the client IP address, CORS origin
(if any and a CORS Filter is configured) and the security client
certificate principal (if any) of an HTTP request.
- log(Logger, HttpServletRequest) - Static method in class com.nimbusds.common.servlet.ServletLogUtility
-
Logs (at INFO level) the method, the client IP address, CORS origin
(if any and a CORS Filter is configured) and the security client
certificate principal (if any) of an HTTP request.
- LOG_CATEGORY - Static variable in interface com.nimbusds.common.config.LoggableConfiguration
-
The preferred logging category.
- logCacheManagerStart(CacheStartedEvent) - Method in class com.nimbusds.common.servlet.InfinispanLauncher.StartLogger
-
- logCacheManagerStop(CacheStoppedEvent) - Method in class com.nimbusds.common.servlet.InfinispanLauncher.StopLogger
-
- LoggableConfiguration - Interface in com.nimbusds.common.config
-
Loggable configuration.
- LoggingWsDetector - Class in com.nimbusds.common.jsonrpc2
-
Logs the detected name and version of a remote JSON-RPC 2.0 web service, as
reported by a
WsInfoRequestHandler.
- LoggingWsDetector(URL, String, Logger) - Constructor for class com.nimbusds.common.jsonrpc2.LoggingWsDetector
-
Creates a new JSON-RPC 2.0 web service detector.
- parse(String) - Static method in class com.nimbusds.common.id.AuthzId
-
Parses a string representation of a SASL authorisation identity.
- parse(NamedParamsRetriever) - Method in class com.nimbusds.common.ldap.AttributesForRetrieval
-
Parses an "attributes" and a "binaryAttributes" specification from
the given named JSON-RPC parameters.
- parse(LDAPException) - Static method in exception com.nimbusds.common.ldap.LDAPConnectionException
-
Creates a new LDAP connection exception from the specified LDAP SDK
exception.
- parseParameters(String) - Static method in class com.nimbusds.common.util.URLUtility
-
Parses the specified URL query string into a parameter map.
- parseServerSideSortRequestControl(List<Object>) - Static method in class com.nimbusds.common.ldap.LDAPControlRequestParser
-
Parses a JSON array (java.util.List) representing a server-side sort
(RFC 2891) request.
- parseSimplePagedResultsControl(Map<String, Object>) - Static method in class com.nimbusds.common.ldap.LDAPControlRequestParser
-
Parses a JSON object (java.util.Map) representing a simple paged
results (RFC 2696) request.
- parseValues(String, NamedParamsRetriever) - Static method in class com.nimbusds.common.ldap.AttributesForRetrieval
-
Parses a JSON-RPC 2.0 parameter representing a set of string values.
- parseVirtualListViewControl(Map<String, Object>) - Static method in class com.nimbusds.common.ldap.LDAPControlRequestParser
-
Parses a JSON object (java.util.Map) representing a virtual list
view (draft-ietf-ldapext-ldapv3-vlv-09) request.
- password - Variable in class com.nimbusds.common.config.CustomKeyStoreConfiguration
-
The password to unlock the custom key store file.
- password - Variable in class com.nimbusds.common.config.CustomTrustStoreConfiguration
-
The password to unlock the custom trust store file.
- password - Variable in class com.nimbusds.common.config.DirectoryUser
-
The directory user password.
- port - Variable in class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
The port number on which the example directory server
must accept LDAP client connections.
- PresetLDAPConnectionFactory - Class in com.nimbusds.common.ldap
-
Factory for establishing LDAP connections to a preset directory server.
- PresetLDAPConnectionFactory(LDAPServerDetails, CustomTrustStoreConfiguration, CustomKeyStoreConfiguration) - Constructor for class com.nimbusds.common.ldap.PresetLDAPConnectionFactory
-
Creates a new preset LDAP connection factory.
- process(JSONRPC2Request, MessageContext) - Method in class com.nimbusds.common.jsonrpc2.WsInfoRequestHandler
-
Processes JSON-RPC 2.0 requests for general information about this
web service.
- readObject(ObjectInput) - Method in class com.nimbusds.common.id.IdentifierExternalizer
-
- readTimeout - Variable in class com.nimbusds.common.config.WebServiceDetails
-
Specifies an HTTP read timeout for web service requests, in
milliseconds.
- register(MetricSet) - Static method in class com.nimbusds.common.monitor.MonitorRegistries
-
Registers a metric set.
- register(String, Metric) - Static method in class com.nimbusds.common.monitor.MonitorRegistries
-
Registers, updates or unregisters a metric.
- register(String, HealthCheck) - Static method in class com.nimbusds.common.monitor.MonitorRegistries
-
Registers, updates or unregisters a health check.
- reportRequestProcTime - Variable in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
If true enables reporting of request processing time by
appending a non-standard "xProcTime" attribute to the JSON-RPC 2.0
responses.
- RequestHandlerWithLifecycle - Interface in com.nimbusds.common.jsonrpc2
-
JSON-RPC 2.0 request handler with lifecycle.
- resolve(SimpleBindRequest) - Static method in class com.nimbusds.common.id.AuthzIdResolver
-
Resolves the authzId (user) of a simple bind request.
- resolve(PLAINBindRequest) - Static method in class com.nimbusds.common.id.AuthzIdResolver
-
Resolves the authzId (user) of a plain SASL bind request.
- resolve(BindRequest) - Static method in class com.nimbusds.common.id.AuthzIdResolver
-
Resolves the authzId (user) of a bind request.
- ResourceRetriever - Class in com.nimbusds.common.servlet
-
Servlet resource retriever.
- responseContentType - Variable in class com.nimbusds.common.config.JSONRPC2WebAPIConfiguration
-
The value of the HTTP "Content-Type" header for the JSON-RPC 2.0
responses.
- responseContentType - Variable in class com.nimbusds.common.jsonrpc2.JSONRPC2Servlet
-
The HTTP (POST) response content type of JSON-RPC 2.0 responses.
- ResultFormat - Enum in com.nimbusds.common.ldap
-
Enumeration of LDAP response result formats.
- reverseTransform(JSONObject) - Method in class com.nimbusds.common.ldap.AttributeMapper
-
Performs a reverse transformation of the specified JSON object
representation of an LDAP entry.
- run() - Method in class com.nimbusds.common.jsonrpc2.LoggingWsDetector
-
Detects and logs the JSON-RPC 2.0 web service name and version.
- schema - Variable in class com.nimbusds.common.ldap.ExampleDirectory.Configuration
-
Specifies an alternative schema for the example directory +
server, supplied in a single LDIF file.
- SchemaUtils - Class in com.nimbusds.common.ldap
-
LDAP schema utilities.
- security - Variable in class com.nimbusds.common.config.LDAPServerDetails
-
The LDAP connection security.
- selectionAlgorithm - Variable in class com.nimbusds.common.config.LDAPServerDetails
-
The preferred algorithm for selecting an LDAP server from the array
specified by
LDAPServerDetails.url,
null if only a single server URL
is defined.
- send(JSONRPC2Request) - Method in class com.nimbusds.common.jsonrpc2.JSONRPC2ServiceConnector
-
Sends the specified JSON-RPC 2.0 request to the service (local or
remote).
- serializeParameters(Map<String, String>) - Static method in class com.nimbusds.common.util.URLUtility
-
Serialises the specified map of parameters into a URL query string.
- serialVersionUID - Static variable in exception com.nimbusds.common.store.StoreException
-
Serial version UID.
- ServerSelectionAlgorithm - Enum in com.nimbusds.common.config
-
Enumeration of server selection algorithms.
- service - Variable in class com.nimbusds.common.jsonrpc2.JSONRPC2Servlet
-
The target JSON-RPC 2.0 service.
- service(HttpServletRequest, HttpServletResponse) - Method in class com.nimbusds.common.servlet.MonitorServlet
-
- ServletLogUtility - Class in com.nimbusds.common.servlet
-
Helper methods for Log4j message generation.
- SID - Class in com.nimbusds.common.id
-
Represents a secure immutable session identifier (SID).
- SID() - Constructor for class com.nimbusds.common.id.SID
-
Creates a new unique session identifier (SID) based on a secure
randomly generated 256-bit number, Base64URL-encoded.
- SID(String) - Constructor for class com.nimbusds.common.id.SID
-
Creates a new session identifier (SID) from the specified string.
- SPLIT_PATTERN - Static variable in class com.nimbusds.common.ldap.AttributeMapper
-
The space split pattern.
- start() - Method in interface com.nimbusds.common.jsonrpc2.RequestHandlerWithLifecycle
-
Starts the request handler.
- start(ExampleDirectory.Configuration) - Method in class com.nimbusds.common.ldap.ExampleDirectory
-
Starts the example in-memory directory server.
- stop() - Method in interface com.nimbusds.common.jsonrpc2.RequestHandlerWithLifecycle
-
Stops the request handler.
- stop() - Method in class com.nimbusds.common.ldap.ExampleDirectory
-
Stops the example in-memory directory server (if previously started).
- Store - Interface in com.nimbusds.common.store
-
Store marker interface.
- StoreException - Exception in com.nimbusds.common.store
-
Store exception.
- StoreException(String) - Constructor for exception com.nimbusds.common.store.StoreException
-
Creates a new store exception.
- StoreException(String, Throwable) - Constructor for exception com.nimbusds.common.store.StoreException
-
Creates a new store exception.
- toJSONRPC2Error(LDAPException) - Static method in class com.nimbusds.common.ldap.LDAPExceptionUtils
-
Turns an LDAP exception into a JSON-RPC 2.0 error with corresponding
code and message.
- toJSONString() - Method in class com.nimbusds.common.id.BaseIdentifier
-
Returns the JSON string representation of this identifier (ID).
- tokenValidator - Variable in class com.nimbusds.common.servlet.MonitorServlet
-
The access token validator.
- toString() - Method in class com.nimbusds.common.id.BaseIdentifier
-
Returns the string representation of this identifier (ID).
- toString() - Method in class com.nimbusds.common.jsonrpc2.WsInfo
-
Returns the string representation of this web service anme and
version.
- toString() - Method in class com.nimbusds.common.ldap.FilterTemplate
-
Returns a string representation of this filter template.
- toWebAppException() - Method in class com.nimbusds.common.oauth2.BasicAccessTokenValidator.ErrorResponse
-
Returns a web application exception for this error response.
- transform(Entry) - Method in class com.nimbusds.common.ldap.AttributeMapper
-
Transforms the specified LDAP entry.
- transform(Map<String, Object>) - Method in class com.nimbusds.common.ldap.AttributeMapper
-
Transforms the specified java.util.Map representation of an
LDAP entry.
- trustSelfSignedCerts - Variable in class com.nimbusds.common.config.LDAPServerDetails
-
Determines whether to accept self-signed certificates presented by
the LDAP server (for secure SSL or StartTLS connections).
- trustSelfSignedCerts - Variable in class com.nimbusds.common.config.WebServiceDetails
-
Specifies whether to accept self-signed X.509 certificates presented
by the web service (for HTTPS connections).
- type - Variable in class com.nimbusds.common.config.CustomKeyStoreConfiguration
-
The type of the custom key store file, typically "JKS" or "PKCS12".
- type - Variable in class com.nimbusds.common.config.CustomTrustStoreConfiguration
-
The type of the custom trust store file, typically "JKS" or "PKCS12".
- validateBearerAccessToken(String) - Method in class com.nimbusds.common.oauth2.BasicAccessTokenValidator
-
Validates a bearer access token passed in the specified HTTP
Authorization header value.
- validateBearerAccessToken(HttpServletRequest, HttpServletResponse) - Method in class com.nimbusds.common.oauth2.BasicAccessTokenValidator
-
Validates a bearer access token passed in the specified HTTP servlet
request.
- valueOf(String) - Static method in enum com.nimbusds.common.config.ServerSelectionAlgorithm
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.nimbusds.common.id.AuthzId.IdentityType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.nimbusds.common.ldap.DirectoryProtocol
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.nimbusds.common.ldap.LDAPConnectionException.CauseType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.nimbusds.common.ldap.LDAPConnectionSecurity
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.nimbusds.common.ldap.ResultFormat
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.nimbusds.common.config.ServerSelectionAlgorithm
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.nimbusds.common.id.AuthzId.IdentityType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.nimbusds.common.ldap.DirectoryProtocol
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.nimbusds.common.ldap.LDAPConnectionException.CauseType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.nimbusds.common.ldap.LDAPConnectionSecurity
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.nimbusds.common.ldap.ResultFormat
-
Returns an array containing the constants of this enum type, in
the order they are declared.