Uses of Annotation Interface
org.forgerock.openam.annotations.Supported
Package
Description
Classes to handle LDAP persistent searches.
Utilities for service management.
This package contains classes fro accessing the Single Sign On service and
representing a SSOToken(Single Sign On) which contains the information
related to session.
This package contains classes that represent SSOProvider
Provides interfaces and classes for writing a Remote Java client application
to authenticate to OpenAM.
This package contains the classes that represent server side
functionality such as the implementation of request for
authenticating, user credential callbacks.
Provides interfaces and classes for writing a supplemental authentication
module to plug into OpenAM.
Defines classes and interfaces to work with entitlements.
Provides classes for accessing the Identity Repository interfaces.
Provides interface for Web Service Security X.509 Certificate Token Profile.
Provides classes to manage Liberty SOAP Binding.
Provides the classes and interfaces of core logging and auditing facilities.
Provides classes for policy administration and evaluation.
Defines Secure Attribute Exchange (SAE) APIs.
Defines common SAML 1.x utilities and constants.
Defines common SAMLv2 utilities and constants.
Package that handles SAML v2 metadata operations.
Package that handles SAML v2 profiles.
Provides classes for accessing the Service Management Service (SMS).
Defines the core classes to implement OAuth2 for OpenAM.
This package contains the API for writing OAuth2 plugins.
Annotations for defining SMS service configurations.
This package contains classes related to authentication node scripts.
This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
Classes to help scripts interact with identities obtained from identity repositories.
A package containing a set of script-friendly classes and functionality that are intended to simplify
use of the Secrets API from within a scripting context.
Wrappers for improving the interface for AM objects using in scripts.
Contains classes for handling self service console configuration.
Service interface for sending email messages and default implementation.
REST implementation for sending email messages.
This package contains security cryptographic utilities for use throughout the OpenAM codebase.
This package contains exception types for service management error scenarios.
Contains classes used to define services and their configuration based on annotations.
Defines interfaces and classes to perform OpenAM system upgrade.
Package
Description
Type adapters for converting a type to and from a set of strings, which is the underlying SMS
representation for configuration.
Contains annotations used by AM.
Contains classes used to define services and their configuration based on annotations.
Defines Secure Attribute Exchange (SAE) APIs.
This package contains the API for writing authentication nodes.
The classes under this package do not support Localisation.
Defines SAML assertion.
Defines SAMLv2 assertion.
Provides interfaces and classes for writing a Remote Java client application
to authenticate to OpenAM.
Contains self service configuration beans.
Defines classes to handle XACML requests.
Defines Federation Common Utils.
Defines common SAML 1.x utilities and constants.
Defines common SAMLv2 utilities and constants.
Defines common WS-Federation utilities and constants.
Defines common XACML Utilities and Constants
Contains classes for handling self service console configuration.
Contains configuration SPI.
Defines XACML2 context classes
Defines the core classes to implement OAuth2 for OpenAM.
This package contains security cryptographic utilities for use throughout the OpenAM codebase.
Defines legacy debug logging classes.
This package contains classes that represent SSOProvider
Defines classes for SAMLv2 ECP profile.
Service interface for sending email messages and default implementation.
Defines classes and interfaces to work with entitlements.
Defines classes to handle entitlements.
Classes to handle LDAP persistent searches.
This package contains the exception classes that may be thrown by AM OAuth2 classes.
Defines the classes and supported interface that customers need to create their own
ResourceRegistrationFilter
.Extension points for integrating with UMA functionality.
Implementation of the Authentication Framework HOTP module and associated classes.
This package contains utilities for HTTP connections.
Classes to help scripts interact with identities obtained from identity repositories.
Provides classes for accessing the Identity Repository interfaces.
Defines XACML Context implementations.
Defines XACML Policy implementations.
Defines XACML implementations for SAMLv2.
Deprecated interfaces for writing custom Policy plugins for Conditions,
Subjects, Referrals, ResponseProviders and Resources.
This package contains classes related to creating the json payloads corresponding to REST-STS and TokenGenerationService
invocations.
Defines classes to handle JAX-RPC.
Defines classes to handle JAX-RPC.
This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
Defines classes to handle localization.
Exception classes for audit logging.
Provides the classes and interfaces of core logging and auditing facilities.
Contains Log SPI.
This package contains the mapping interfaces and default implementations that are common for use by all
authentication modules.
Package that handles SAML v2 metadata operations.
Provides classes for the OAuth 2.0 authentication module.
Classes that provide AM's features as an OAuth 2.0 Authorization Server.
Classes related to producing OpenIdConnect tokens
This package contains classes defining OpenId Connect Token generation and claim mapping.
Classes required for the AM OAuth2 OIDC implementation.
XML parsing utility.
Defines SAMLv2 Plugin SPIs.
Defines WS-Federation Plugin SPIs
This package contains the API for writing OAuth2 plugins.
Classes in this package provide plugin functionality for the oath module.
This package contains the API for writing AM plugins.
Provides classes for policy administration and evaluation.
Defines XACML Policy classes.
Classes pertaining to the predicates used by the Push Service's Message Dispatcher.
Package that handles SAML v2 profiles.
SAMLv2 Protocol Classes.
Contains classes and interface definitions common to all token provider classes.
Defines classes for the Push Notification service and framework.
Classes to handle policies remotely.
This package contains classes for the handling of REST request to CREST Resource endpoints with the concept of realms
in OpenAM built in.
This package contains url resource name utilities for use throughout the OpenAM codebase.
REST implementation for sending email messages.
Defines XACML interfaces for SAMLv2
This package contains classes related to authentication node scripts.
A package containing a set of script-friendly classes and functionality that are intended to simplify
use of the Secrets API from within a scripting context.
Provides the classes to be used for performing privileged operations (like
getting the OpenAM administrator's DN and password).
This package contains the classes that represent server side
functionality such as the implementation of request for
authenticating, user credential callbacks.
This package contains classes and interfaces that represent
methods to validate/update/destroy/persist/retrieve the internal session data
A collection of classes which support the authentication service.
Defines interfaces and classes for the Session Service.
Contains session SPI.
Provides classes for accessing the Service Management Service (SMS).
Annotations for defining SMS service configurations.
This package contains exception types for service management error scenarios.
Provides interfaces and classes for writing a supplemental authentication
module to plug into OpenAM.
Provides means for plugging in support for authorization and other security
related aspects of logging.
This package contains classes fro accessing the Single Sign On service and
representing a SSOToken(Single Sign On) which contains the information
related to session.
This package contains classes defining the interfaces consumed to obtain the various statements contituting SAML2
assertions.
Defines classes to interact with statistics.
Base package for classes shared between the SOAP and REST STS.
Contains the classes related to token operations.
Classes that support AM's UMA AS functionality.
Defines interfaces and classes to perform OpenAM system upgrade.
Contains the classes which encapsulate the user-provided configuration state necessary to publish a STS instance.
Provides utility classes for use by other OpenAM SDK and custom
applications accessing OpenAM SDK.
Utilities for service management.
This package contains general utilities for use throughout the OpenAM codebase.
Token validation occurs in three contexts in the sts:
1.
Validator classes for SMS.
Defines classes for basic resource matching.
Wrappers for SAML Script bindings
Wrappers for improving the interface for AM objects using in scripts.
Provides interface for Web Service Security X.509 Certificate Token Profile.
Defines KeyProvider interface and default implementation class.
-
Uses of Supported in com.iplanet.services.ldap.event
Modifier and TypeClassDescriptionclass
class
Exception occurs while setting an event request or when trigering the "entryChanged()" method after a persistent search results are received from the Directory Server.class
The EventService is responsible for listening to and dispatching to listening objects messages returning from persistent searches running in an underlying LDAP implementation.interface
The purpose of this interface is to allow classes that implement this interface to listen to Directory Server Events.Modifier and TypeMethodDescriptionvoid
IDSEventListener.entryChanged
(DSEvent e) This callback method is called by the EventService when the Directory Server triggers a PersistentSearch notificationvoid
IDSEventListener.eventError
(String err) This callback method is called by the EventService when an error is encountered after setting a Persistent Search request in the Directory ServerDSEvent.getClassName()
Returns the Directory Server class name for the given entrystatic EventService
EventService.getEventService()
Returns the event service (presuming we are not in the process of shutting down).int
DSEvent.getEventType()
Returns the type of change event either add, modify, delete, etc.DSEvent.getID()
Return the Directory Server ID assigned to the entry changedEventException.getMessage()
Returns a string representation of the message in the this EventException (if present)DSEvent.getSearchID()
Returns the Directory Server search ID that was assigned when the persistent search was first submited.void
EventException.printStackTrace()
Prints a stack trace for this EventException to System.out;void
EventException.printStackTrace
(PrintStream printStream) Prints a stack trace for this EventException to the given PrintStream;void
EventException.printStackTrace
(PrintWriter printWriter) Prints a stack trace for this EventException to the given PrintWriter;EventException.toString()
Returns a string representation of this EventException, including the detail message (if present);ModifierConstructorDescriptionEventException
(String msg) Constructs a EventException with a detail message.EventException
(String msg, Throwable t) Constructor with message string and an embedded exception Constructs a EventException with the given detail message and nested exception. -
Uses of Supported in com.iplanet.services.util
Modifier and TypeClassDescriptionclass
TheI18n
class provides methods for applications and services to internationalize their messages.Modifier and TypeMethodDescriptionstatic I18n
I18n.getInstance
(String serviceName) Method to get an instance of I18n object that has been either previously created or to obtain a new instance if it does'nt existMethod to obtain internationalized message from the resource bundle given the key.Method to obtain internationalized message from the resource bundle given the key and parameters.Method to obtain internationalized message from the resource bundle given the key and locale.Method to obtain internationalized message from the resource bundle given the key, locale and parameters. -
Uses of Supported in com.iplanet.sso
Modifier and TypeClassDescriptionclass
SSOTokenManager is the final class that is the mediator between the SSO APIs and SSO providers.Modifier and TypeMethodDescriptionSSOTokenManager.createSSOToken
(String tokenId) Creates a single sign on token from the single sign on token ID.SSOTokenManager.createSSOToken
(String tokenId, String clientIP) Creates a single sign on token from the single sign on token ID.SSOTokenManager.createSSOToken
(javax.servlet.http.HttpServletRequest request) Creates a single sign on token fromHttpServletRequest
void
SSOTokenManager.destroyToken
(SSOToken token) Destroys a single sign on token.void
SSOTokenManager.destroyToken
(SSOToken destroyer, SSOToken destroyed) Destroys a single sign on token.static SSOTokenManager
SSOTokenManager.getInstance()
Returns the singleton instance ofSSOTokenManager
.SSOTokenManager.getValidSessions
(SSOToken requester, String server) Returns a list of single sign on token objects which correspond to valid Sessions accessible to requester.boolean
SSOTokenManager.isValidToken
(SSOToken token) Returns true if a single sign on token is valid.boolean
SSOTokenManager.isValidToken
(SSOToken token, boolean resetIdleTime) Returns true if a single sign on token is valid, resetting the token's idle time if and only if the flag allows us to.void
SSOTokenManager.refreshSession
(SSOToken token) Refresh the Session corresponding to the single sign on token from the Session Server.void
SSOTokenManager.validateToken
(SSOToken token) Returns true if the single sign on token is valid. -
Uses of Supported in com.iplanet.sso.providers.dpro
Modifier and TypeClassDescriptionfinal class
Thisfinal
classSSOProviderImpl
implementsSSOProvider
interface and provides implementation of the methods to create , destroy , check the validity of a single sign on token.Modifier and TypeMethodDescriptionvoid
SSOProviderImpl.destroyToken
(SSOToken destroyer, SSOToken destroyed) Destroys a single sign on token.SSOProviderImpl.getValidSessions
(SSOToken requester, String server) Returns a list of single sign on token objects which correspond to valid Sessions accessible to requester. -
Uses of Supported in com.sun.identity.authentication
Modifier and TypeClassDescriptionclass
TheAuthContext
provides the implementation for authenticating users.Modifier and TypeMethodDescriptionvoid
AuthContext.abort()
Terminates an ongoinglogin
call that has not yet completed.AuthContext.getClientHostName()
Returns the client's hostname or IP address as set by setClientHostNameAuthContext.getLoginException()
Returns login exception, if any, during the authentication process.AuthContext.getModuleInstanceNames()
Returns authentication module/s instances (or plugins) configured for a organization, or sub-organization name that was set during theAuthContext
constructor.AuthContext.getOrganizationName()
Returns the the organization name that was set during theAuthContext
constructor.Callback[]
AuthContext.getRequirements()
Returns an array ofCallback
objects that must be populated by the user and returned back.Callback[]
AuthContext.getRequirements
(boolean noFilter) Returns an array ofCallback
objects that must be populated by the user and returned back.AuthContext.getSSOToken()
Returns the Single-Sign-On (SSO) Token for the authenticated user.AuthContext.getStatus()
Returns the current status of the authentication process asAuthContext.Status
.AuthContext.getSubject()
Returns the set of Principals or Subject the user has been authenticated as.boolean
AuthContext.hasMoreRequirements()
Returnstrue
if the login process requires more information from the user to complete the authentication.boolean
AuthContext.hasMoreRequirements
(boolean noFilter) Returnstrue
if the login process requires more information from the user to complete the authentication.void
AuthContext.login()
Starts the login process for the givenAuthContext
object.void
AuthContext.login
(AuthContext.IndexType type, String indexName) Starts the login process for the givenAuthContext
object identified by the index type and index name.void
AuthContext.login
(AuthContext.IndexType indexType, String indexName, String[] params) Starts the login process for the givenAuthContext
object identified by the index type and index name with default parameters.void
AuthContext.login
(AuthContext.IndexType indexType, String indexName, String[] params, Map envMap) Starts the login process for the givenAuthContext
object identified by the index type and index name with certain parameters and environment map.void
AuthContext.login
(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Starts the login process for the givenAuthContext
object.void
AuthContext.logout()
Logs out the user and also invalidates the single sign on token associated with thisAuthContext
.void
AuthContext.logoutUsingTokenID()
Logs out the user and also invalidates the single sign on token associated with thisAuthContext
.void
AuthContext.setClientHostName
(String hostname) Sets the client's hostname or IP address.This could be used by the policy component to restrict access to resources.void
AuthContext.submitRequirements
(Callback[] info) Submits the populatedCallback
objects to the authentication plug-in modules.ModifierConstructorDescriptionAuthContext
(SSOToken ssoToken) Constructs an instance ofAuthContext
for a given organization name, or sub organization name contained in the single sign on token.AuthContext
(SSOToken ssoToken, boolean forceAuth) Constructs an instance ofAuthContext
for a given organization name, or sub organization name contained in the single sign on token.AuthContext
(String orgName) Constructs an instance ofAuthContext
for a given organization name or sub organization name.AuthContext
(String orgName, URL url) Constructs an instance ofAuthContext
for a given organization name, or sub organization name and the OpenAM server URL. -
Uses of Supported in com.sun.identity.authentication.server
Modifier and TypeClassDescriptionfinal class
TheAuthContextLocal
provides the implementation for authenticating users.Modifier and TypeMethodDescriptionvoid
AuthContextLocal.abort()
Terminates an ongoinglogin
call that has not yet completed.AuthContextLocal.getLoginException()
Returns login exception, if any, during the authentication process.AuthContextLocal.getModuleInstanceNames()
Returns authentication module/s instances(or) plugin(s) configured for an organization, or sub-organization that was set during theAuthContext
constructor.AuthContextLocal.getOrganizationName()
Returns the the organization name that was set during theAuthContextLocal
constructor.Callback[]
AuthContextLocal.getRequirements()
Returns an array ofCallback
objects that must be populated by the user and returned back.Callback[]
AuthContextLocal.getRequirements
(boolean noFilter) Returns an array ofCallback
objects that must be populated by the user and returned back.AuthContextLocal.getSSOToken()
Returns the Single-Sign-On (SSO) Token for the authenticated user.Single-Sign-On token can be used as the authenticated token.AuthContextLocal.getStatus()
Returns the current status of the authentication process.AuthContextLocal.getSubject()
Returns the set of Principals the user has been authenticated as.boolean
AuthContextLocal.hasMoreRequirements()
Checks if the login process requires more information from the user to complete the authentication.void
AuthContextLocal.login()
Starts the login process for the givenAuthContextLocal
object.void
AuthContextLocal.login
(AuthContext.IndexType type, String indexName) Start the login process for theAuthContextLocal
object identified by the index type and index name.void
Starts the login process for the givenAuthContextLocal
s object for the givenPrincipal
and the user's password.void
Starts the login process for the givenAuthContextLocal
object for the givenSubject
.void
AuthContextLocal.logout()
Logs out the user and also invalidates theSSOToken
associated with thisAuthContextLocal
.void
AuthContextLocal.submitRequirements
(Callback[] info) Submit the populatedCallback
objects to the authentication plug-in modules.ModifierConstructorDescriptionAuthContextLocal
(String orgName) CreatesAuthContextLocal
instance is obtained for a given organization name, or sub organization name. -
Uses of Supported in com.sun.identity.authentication.spi
Modifier and TypeClassDescriptionclass
An abstract class which implements JAAS LoginModule, it provides methods to access OpenAM services and the module xml configuration.class
This class is for handling message localization in LoginException.Modifier and TypeMethodDescriptionvoid
AMLoginModule.clearInfoText
(int state) Clears the info text for a given callback statevoid
AMLoginModule.destroyModuleState()
This method should be overridden by each login module to destroy dispensable state fields.AMLoginModule.getAttribute
(int state, int index) Returns the attribute name for the specified callback in the specified login state.int
AMLoginModule.getAuthLevel()
Returns authentication level that has been set for the moduleCallback[]
AMLoginModule.getCallback
(int index) Returns a Callback array for a specific state.Callback[]
AMLoginModule.getCallback
(int index, boolean fetchOrig) Return a Callback array for a specific state.int
AMLoginModule.getCurrentState()
Returns the current state in the authentication process.AuthLoginException.getErrorCode()
Returns the error code.int
AMLoginModule.getFailCount
(AMIdentity amIdUser) Get the number of failed login attempts for a user when account locking is enabled.javax.servlet.http.HttpServletRequest
AMLoginModule.getHttpServletRequest()
Returns theHttpServletRequest
object that initiated the call to this module.javax.servlet.http.HttpServletResponse
AMLoginModule.getHttpServletResponse()
Returns theHttpServletResponse
object for the servlet request that initiated the call to this module.AMLoginModule.getInfoText
(int state, int index) Returns the info text associated with a specific callbackAuthLoginException.getL10NMessage
(Locale locale) Returns the localized message of the given locale.AMLoginModule.getLocale()
Returns the locale for this authentication session.int
AMLoginModule.getMaximumFailCount()
Get the maximum number failed login attempts permitted for a user before when their account is locked out.AuthLoginException.getMessage()
Gets messages of the exceptions including the nested exceptions.Object[]
AuthLoginException.getMessageArgs()
Returns the error message arguments.AMLoginModule.getNewUserIDs
(Map attributes, int num) Returns a set of user IDs generated from the class defined in the Core Authentication Service.int
AMLoginModule.getNumberOfStates()
Returns the number of authentication states for this login module.AMLoginModule.getOrgProfile
(String orgDN) Returns the organization attributes for specified organization.AMLoginModule.getOrgServiceTemplate
(String orgDN, String serviceName) Returns service template attributes defined for the specified organization.abstract Principal
AMLoginModule.getPrincipal()
Abstract method must be implemeted by each login module to get the user PrincipalAMLoginModule.getRequestOrg()
Returns the organization DN for this authentication session.AuthLoginException.getResourceBundleName()
Returns the resource bundle name.AMLoginModule.getServiceConfig
(String name) Returns service configuration attributes.AMLoginModule.getSessionId()
Returns a unique key for this authentication session.AMLoginModule.getSSOSession()
Returns an administration SSOToken for use the OpenAM APIs.AMLoginModule.getUserSessionProperty
(String name) Returns the property from the user session.AMLoginModule.getUserSessions
(String userName) Returns the set of SSOTokens for a specified uservoid
AMLoginModule.incrementFailCount
(String userName) Increments the fail count for the given user.abstract void
Initialize this LoginModule.boolean
AMLoginModule.isAccountActive
(String userName) Returns true if the named account is active, false otherwise.boolean
AMLoginModule.isAccountLocked
(String userName) Returns true if the named account is locked out, false otherwise.boolean
AMLoginModule.isRequired
(int state, int index) Checks if a Callback is required to have input.boolean
AMLoginModule.isReturningPrincipalAsDn()
Defines whether the principal being returned is a DN.boolean
AMLoginModule.isSessionQuotaReached
(String userName) Returns true if the user identified by the supplied username has reached their session quota.
NBThe existing session count is exclusive of any session created as part of the running authentication processabstract int
Abstract method must be implemented by each login module to control the flow of the login process.void
AMLoginModule.replaceCallback
(int state, int index, Callback callback) Replace Callback object for a specific state.void
AMLoginModule.resetCallback
(int state, int index) Reset a Callback instance to the original Callback for the specified state and the specified index.boolean
AMLoginModule.setAuthLevel
(int auth_level) Sets theAuthLevel
for this session.void
AMLoginModule.setFailureID
(String userID) Sets theuserID
of user who failed authentication.void
AMLoginModule.setLoginFailureURL
(String url) Sets the the login failure URL for the user.void
AMLoginModule.setLoginSuccessURL
(String url) Sets the the login successful URL for the user.void
AMLoginModule.setUserAttributes
(Map attributeValuePairs) Sets a Map of attribute value pairs to be used when the authentication service is configured to dynamically create a user.void
AMLoginModule.setUserSessionProperty
(String name, String value) Sets a property in the user session.void
AMLoginModule.substituteHeader
(int state, String header) Use this method to replace the header text from the XML file with new text.void
AMLoginModule.substituteInfoText
(int state, int callback, String infoText) Allows you to set the info text for a specific callback.void
AMLoginModule.validatePassword
(String userPassword) Deprecated.void
AMLoginModule.validateUserName
(String userName, String invalidChars) Validates the given user name by using validation plugin if exists else it checks invalid characters in the source string.ModifierConstructorDescriptionAuthLoginException
(String message) Constructs a newAuthLoginException
with the given message.AuthLoginException
(String rbName, String errorCode, Object[] args) Constructs a newAuthLoginException
without a nestedThrowable
.AuthLoginException
(String rbName, String errorCode, Object[] args, Throwable nestedException) Constructs an instance ofAuthLoginException
to pass the localized error message At this level, the locale of the caller is not known and it is not possible to throw localized error message at this level.AuthLoginException
(Throwable nestedException) Constructs anAuthLoginException
with givenThrowable
. -
Uses of Supported in com.sun.identity.entitlement
Modifier and TypeClassDescriptionclass
The class evaluates entitlement request and provides decisions.Modifier and TypeMethodDescriptionList<com.sun.identity.entitlement.Entitlement>
Evaluator.evaluate
(String realm, Subject subject, String resourceName, Map<String, Set<String>> environment, boolean recursive) Returns a list of entitlements for a given subject, resource name and environment.List<com.sun.identity.entitlement.Entitlement>
Evaluator.evaluate
(String realm, Subject subject, Set<String> resourceNames, Map<String, Set<String>> environment) Returns a list of entitlements for a given subject, resource names and environment. -
Uses of Supported in com.sun.identity.idm
Modifier and TypeClassDescriptionclass
This class represents an Identity which needs to be managed by Access Manager.class
The classAMIdentityRepository
represents an object to access the repositories in which user/role/group and other identity data is configured.final class
The class defines some static utilities used by other components like policy and authModifier and TypeMethodDescriptionint
AMIdentityRepository.addEventListener
(IdEventListener listener) Add anIdEventListener
to the pool of listeners.void
AMIdentity.addMember
(AMIdentity identity) Adds the passed identity as a member of this identity.void
AMIdentity.addMembers
(Set<AMIdentity> identities) Adds the passed identities as members of this identity.void
AMIdentity.assignService
(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attributes) Assigns the service and service related attributes to the identity.void
AMIdentity.changePassword
(String oldPassword, String newPassword) Changes password for the identity.static void
AMIdentityRepository.clearCache()
Clear caches related to Identity repositories.AMIdentityRepository.createIdentities
(IdType type, Map<String, Map<?, ?>> identityNamesAndAttrs) Create a set ofAMIdentity
s.AMIdentityRepository.createIdentity
(IdType type, String idName, Map attrMap) Create anAMIdentity
object.void
AMIdentityRepository.deleteIdentities
(IdType type, Set identities) Delete a set of identities byIdType
.void
AMIdentityRepository.deleteIdentities
(Set<AMIdentity> identities) Delete a set ofAMIdentity
s.boolean
AMIdentityRepository.getAllowedIdOperations
(IdType type) Get allowed identity operations.AMIdentity.getAssignableServices()
Returns all services which can be assigned to this entity.AMIdentity.getAssignedServices()
Returns the set of services already assigned to this identity.AMIdentity.getAttribute
(String attrName) Returns the values of the requested attribute.AMIdentity.getAttributes()
Returns all attributes and values of this identity.AMIdentity.getAttributes
(Set<String> attrNames) Returns requested attributes and values of this object.AMIdentity.getBinaryAttributes
(Set attrNames) Returns requested attributes and values of this object.static AMIdentity
IdUtils.getIdentity
(SSOToken token) static AMIdentity
IdUtils.getIdentity
(SSOToken token, String univId) static AMIdentity
IdUtils.getIdentity
(String uName, String realm) Gets the AMIdentity of a user with username equal to uName that exists in realmstatic AMIdentity
IdUtils.getIdentity
(String uName, String realm, Set<String> userSearchAttributes) Gets the AMIdentity of a user with username equal to uName that exists in realm.AMIdentity.getMembers
(IdType mtype) Return all members of a given identity type of this identity as a Set of AMIdentity objects.AMIdentity.getMemberships
(IdType mtype) Returns the set of identities that this identity belongs to.AMIdentity.getName()
Returns the name of the identity.AMIdentity.getRealm()
Returns the realm for this identity.AMIdentityRepository.getRealmIdentity()
Get the realmAMIdentity
object.AMIdentity.getServiceAttributes
(String serviceName) Returns attributes related to a service, if the service is assigned to the identity.AMIdentity.getServiceAttributesAscending
(String serviceName) Returns attributes related to a service, if the service is assigned to the identity.AMIdentityRepository.getSupportedIdTypes()
Get supported identity types.AMIdentity.getType()
Returns the Type of the Identity.AMIdentity.getUniversalId()
Returns the universal identifier of this object.static String
IdUtils.getUniversalId
(AMIdentity id) boolean
AMIdentity.isActive()
If there is a status attribute configured, then verifies if the identity is active and returns true.boolean
AMIdentity.isExists()
This method determines if the identity exists and returns true or false.boolean
AMIdentity.isMember
(UniversalId universalId) Verifies if this identity is a member of the identity being passed.void
AMIdentity.modifyService
(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attrMap) Set attributes related to a specific service.void
AMIdentity.removeAttributes
(Set<String> attrNames) Removes the attributes from the identity entry.void
AMIdentityRepository.removeEventListener
(int identifier) Remove anIdEventListener
from the pool of listeners.void
AMIdentity.removeMember
(AMIdentity identity) Removes the passed identity as a member of this identity.void
AMIdentity.removeMembers
(Set<AMIdentity> identities) Removes the passed identities as members of this identity.void
AMIdentity.removeServiceAttributes
(String serviceName, Set<String> attrNames) Removes attributes value related to a specific service by setting it to empty.AMIdentityRepository.searchIdentities
(IdType type, String pattern, IdSearchControl ctrl) Search for identities of certain types from each plugin and returns a combined result.void
AMIdentity.setActiveStatus
(boolean active) If there is a status attribute configured, then set its status to true or activated state if the parameter active is true.void
AMIdentity.setAttributes
(Map attrMap) Sets the values of attributes.void
AMIdentity.setBinaryAttributes
(Map attrMap) Set the values of binary attributes.void
AMIdentity.store()
Stores the attributes of the object.void
AMIdentity.unassignService
(String serviceName) Removes a service from the identity.ModifierConstructorDescriptionAMIdentity
(SSOToken token) Constructs a newAMIdentity
instance from the passed token.AMIdentity
(SSOToken token, String universalId) Constructs a newAMIdentity
instance from the passed universal ID.AMIdentityRepository
(SSOToken ssoToken, String realmName) Deprecated.AMIdentityRepository
(String realmName, SSOToken ssoToken) Instantiates a newAMIdentityRepository
. -
Uses of Supported in com.sun.identity.liberty.ws.common.wsse
Modifier and TypeClassDescriptionclass
The classBinarySecurityToken
provides interface to parse and create X.509 Security Token depicted by Web Service Security : X.509 Certificate Token Profile and Liberty ID-WSF Security Mechanisms specifications.Modifier and TypeFieldDescriptionstatic final QName
BinarySecurityToken.BASE64BINARY
TheBASE64BINARY
encoding type indicates that the encoding name given corresponds to base64 encoding of a binary value.static final QName
BinarySecurityToken.HEXBINARY
TheHEXBINARY
encoding type indicates that the encoding name given corresponds to Hex encoding of a binary value.static final QName
BinarySecurityToken.PKCS7
ThePKCS7
value type indicates that the value name given corresponds to a PKCS7 object.static final QName
BinarySecurityToken.PKIPath
ThePKIPATH
value type indicates that the value name given corresponds to a PKI Path object.static final QName
BinarySecurityToken.X509V3
TheX509V3
value type indicates that the value name given corresponds to a X509 Certificate.Modifier and TypeMethodDescriptionBinarySecurityToken.getEncodingType()
Gets encoding type for the token.BinarySecurityToken.getId()
Gets id attribute for the tokens.BinarySecurityToken.getTokenValue()
Gets value of the token.BinarySecurityToken.getValueType()
Gets value type for the token.BinarySecurityToken.toString()
Returns a String representation of the token. -
Uses of Supported in com.sun.identity.liberty.ws.soapbinding
Modifier and TypeMethodDescriptionstatic String
Utils.BooleanToString
(Boolean bool) Converts a Boolean object to a String representing XML boolean.static QName
Utils.convertStringToQName
(String str, Element element) Converts a string value to a QName.static String
Gets localized string from resource bundle.static Boolean
Utils.StringToBoolean
(String str) Converts a value of XML boolean type to Boolean object. -
Uses of Supported in com.sun.identity.log
Modifier and TypeFieldDescriptionstatic final String
LogConstants.ALL_FIELDS
Deprecated.Attribute defining the set of all fields being logged.static final String
LogConstants.BACKEND
Deprecated.Attribute defining whether the logs to be stored in flat-files or to a Database.static final String
LogConstants.BUFFER_SIZE
Deprecated.Attribute defining the Buffer size.static final String
LogConstants.BUFFER_TIME
Deprecated.Attribute defining the Buffering time.static final String
LogConstants.CONTEXT_ID
Deprecated.The ContextID field.static final String
LogConstants.CRLF
Deprecated.Defines CarriageReturn/LineFeed characters.static final String
LogConstants.DATA
Deprecated.The Data field.static final String
LogConstants.DB_DRIVER
Deprecated.Attribute defining the Database Driver.static final String
LogConstants.DB_MEM_MAX_RECS
Deprecated.Attribute defining the Maximum LogRecords held in memory if DB logging fails.static final String
LogConstants.DEBUG_IMPL_CLASS
Deprecated.Attribute defining the Class that implements the custom debug method in the case of log failure.static final String
LogConstants.DOMAIN
Deprecated.The Domain field.static final String
LogConstants.HOST_NAME
Deprecated.The HostName field.static final String
LogConstants.IP_ADDR
Deprecated.The IPAddr field.static final String
LogConstants.LOG_FIELDS
Deprecated.Attribute defining the fields currently selected by the administrator to be logged.static final String
LogConstants.LOG_LEVEL
Deprecated.The LogLevel field.static final String
LogConstants.LOG_LOCATION
Deprecated.Attribute defining the location where the logs go.static final String
LogConstants.LOG_STATUS
Deprecated.Property defining whether logging is enabledstatic final String
LogConstants.LOGGED_BY
Deprecated.The LoggedBy field.static final String
LogConstants.LOGGING_SERVICE
Deprecated.Defines the LoggingService name.static final String
LogConstants.LOGIN_ID
Deprecated.The LoginID field.static final int
LogConstants.MAX_FIELDS
Deprecated.The maximum number of fields in a "regular" record.static final String
LogConstants.MAX_FILE_SIZE
Deprecated.Attribute defining the maximum (flat) file size, above which the files are either archived or rotated.static final String
LogConstants.MESSAGE_ID
Deprecated.The MessageID field.static final String
LogConstants.MODULE_NAME
Deprecated.The ModuleName field.static final String
LogConstants.NAME_ID
Deprecated.The NameID field.static final String
LogConstants.NUM_HISTORY_FILES
Deprecated.Attribute defining the number of history files a (flat file) log should have.static final String
LogConstants.TIME
Deprecated.The Date/Time field.static final String
LogConstants.TIME_BUFFERING_STATUS
Deprecated.Attribute defining the Time Buffering Status; ON or OFF.Modifier and TypeMethodDescriptionvoid
LogRecord.addLogInfo
(String key, Object value) Deprecated.Adds to the log information map, the field key and its corresponding value.LogRecord.getLogInfoMap()
Deprecated.Returns the log information map which contains the set of fields and their corresponding values.void
LogRecord.setLogInfoMap
(Map logInfoMap) Deprecated.Convenience method to set the log information map. -
Uses of Supported in com.sun.identity.policy
Modifier and TypeClassDescriptionclass
Deprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlement
instead asEntitlement
has replacedPolicy
.class
Deprecated.As of OpenSSO Express 8.0, useEntitlement
instead asEntitlement
has replacedPolicy
.class
Deprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlement
instead asEntitlement
has replacedPolicy
.class
Deprecated.final class
Deprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlement
instead asEntitlement
has replacedPolicy
.class
Deprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlement
instead asEntitlement
has replacedPolicy
.class
Deprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlement
instead asEntitlement
has replacedPolicy
.Modifier and TypeFieldDescriptionstatic final String
PolicyEvaluator.ALL_RESOURCES
Deprecated.Constant used to identity all the resources of a service type.static final String
PolicyEvaluator.EMPTY_RESOURCE_NAME
Deprecated.Constant used to identity empty resourcestatic final String
PolicyManager.ORGANIZATION_NAME
Deprecated.The key for the plugins to get the organization name.static final String
PolicyManager.POLICY_SERVICE_NAME
Deprecated.The service name for Policy component.static final String
ResourceResult.SELF_SCOPE
Deprecated.Constant to indicate base (self) level scope forResourceResult
evaluationstatic final String
ResourceResult.STRICT_SUBTREE_SCOPE
Deprecated.Constant to indicate strict subtree level scope forResourceResult
evaluationstatic final String
ResourceResult.SUBTREE_SCOPE
Deprecated.Constant to indicate subtree level scope for ResourceResult evaluationModifier and TypeMethodDescriptionvoid
PolicyDecision.addActionDecision
(ActionDecision actionDecision) Deprecated.Adds an action decision to this object if there is already an existing actionDecision associated with the action name in the paramactionDecision
, merges the values of the new decision with the existing one, changing the time to live for the decision appropriately.void
Policy.addCondition
(String name, Condition condition) Deprecated.Adds a new policy condition.void
Deprecated.Adds a policy to the data store.void
PolicyEvaluator.addPolicyListener
(PolicyListener policyListener) Deprecated.Adds a policy listener that would be notified whenever a policy is added, removed or changedvoid
Policy.addRealmSubject
(SSOToken token, String subjectName, String realmName, boolean exclusive) Deprecated.Adds a reference in the policy to a Subject defined at the realm.void
Policy.addRealmSubject
(String subjectName, SubjectTypeManager stm, boolean exclusive) Deprecated.Adds a reference in the policy to a Subject defined at the realm.void
Policy.addReferral
(String name, Referral referral) Deprecated.Adds a new policy referral.void
Deprecated.Adds a new policy rule.void
Policy.addSubject
(String name, Subject subject) Deprecated.Adds a new policy subject.void
Policy.addSubject
(String name, Subject subject, boolean exclusive) Deprecated.Adds a new policy subject.PolicyDecision.getActionDecisions()
Deprecated.Gets theMap
of action decisions associated with this policy decision.ActionDecision.getActionName()
Deprecated.Gets the name of the actionRule.getActionNames()
Deprecated.Returns the action names that have been set for the rule.Rule.getActionValues()
Deprecated.Returns aMap
of all action names and their corresponding action values that have been set in the rule.Rule.getActionValues
(String actionName) Deprecated.Returns a set of action values that have been set for the specified action name.ActionDecision.getAdvices()
Deprecated.Returns aMap
ofadvices
associated with this object.Policy.getCondition
(String condition) Deprecated.Gets the condition object identified by name.Policy.getConditionNames()
Deprecated.Get the set of condition names associated with the policy.PolicyManager.getConditionTypeManager()
Deprecated.Gets theConditionTypeManager
object instance associated with thisPolicyManager
object instancePolicy.getDescription()
Deprecated.Gets the description for the policy.Policy.getName()
Deprecated.Gets the name of the policy.Rule.getName()
Deprecated.Returns the name assigned to the rule.Policy.getOrganizationName()
Deprecated.Gets the organization name under which the policy is created This would be set only for policies that have been read from data store.PolicyManager.getOrganizationName()
Deprecated.Gets the organization name for which the policy manager was initialized with.Deprecated.Gets the policy object given the name of the policy.PolicyEvaluator.getPolicyDecision
(SSOToken token, String resourceName, Set actionNames, Map envParameters) Deprecated.Evaluates privileges of the user to perform the specified actions on the specified resource.ResourceResult.getPolicyDecision()
Deprecated.Returns the policy decision associated with this resource resultPolicyManager.getPolicyNames()
Deprecated.Gets a set of names of polices defined in the organization for which the policy manager was instantiated.PolicyManager.getPolicyNames
(String pattern) Deprecated.Gets a set of selected policy names matching the pattern in the given organization.Policy.getReferral
(String referralName) Deprecated.Gets the Referral object identified by name.Policy.getReferralNames()
Deprecated.Get theSet
of referral names associated with the policy.PolicyManager.getReferralTypeManager()
Deprecated.ReturnsReferralTypeManager
associated with this policy manager.com.sun.identity.policy.ResourceManager
PolicyManager.getResourceManager()
Deprecated.Gets theResourceManager
object instance associated with thisPolicyManager
object instanceResourceResult.getResourceName()
Deprecated.Returns the resource name of this resource resultRule.getResourceName()
Deprecated.Returns the resource name for which the rule has been created.Rule.getResourceNames()
Deprecated.Returns the resource names for which the rule has been created.PolicyEvaluator.getResourceResults
(SSOToken userToken, String resourceName, String scope, Map envParameters) Deprecated.Gets resource result objects given a resource name.ResourceResult.getResourceResults()
Deprecated.Returns the child resource results of this resource resultDeprecated.Gets the rule object identified by name.Policy.getRuleNames()
Deprecated.Gets the set of rule names associated with the policy.Rule.getServiceTypeName()
Deprecated.Returns the service name for which the rule has been created.Policy.getSubject
(String subjectName) Deprecated.Gets the Subject object identified by name.Policy.getSubjectNames()
Deprecated.Get theSet
of subject names associated with the policy.PolicyManager.getSubjectTypeManager()
Deprecated.Gets theSubjectTypeManager
object instance associated with thisPolicyManager
object instancelong
ActionDecision.getTimeToLive()
Deprecated.Gets the GMT time in milliseconds since epoch when this object is to be treated as expired.ActionDecision.getValues()
Deprecated.Gets the action values for the action.boolean
Policy.isActive()
Deprecated.Checks whether the policy is active or inactive An inactive policy is not used to make policy evaluations.boolean
PolicyEvaluator.isAllowed
(SSOToken token, String resourceName, String actionName, Map envParameters) Deprecated.Evaluates simple privileges of boolean type.boolean
Policy.isRealmSubject
(String subjectName) Deprecated.Checks if the subjectName is a reference to a Subject defined at the realmboolean
Policy.isReferralPolicy()
Deprecated.Checks whether the policy is a referral policy.boolean
Policy.isSubjectExclusive
(String subjectName) Deprecated.Checks if the subject is exclusive.void
Policy.removeCondition
(Condition condition) Deprecated.Removes theCondition
object identified by object'sequals
method.Policy.removeCondition
(String condition) Deprecated.Removes the condition with the given name.void
PolicyManager.removePolicy
(String policyName) Deprecated.Deletes a policy in the organization with the given name.void
PolicyEvaluator.removePolicyListener
(PolicyListener policyListener) Deprecated.Removes a policy listener that was previously registered to receive notifications whenever a policy is added, removed or changed.void
Policy.removeReferral
(Referral referral) Deprecated.Removes theReferral
object identified by object'sequals
method.Policy.removeReferral
(String referralName) Deprecated.Removes the referral with the given name.Policy.removeRule
(String ruleName) Deprecated.Removes theRule
with the given name.void
Policy.removeSubject
(Subject subject) Deprecated.Removes theSubject
object identified by object'sequals
method.Policy.removeSubject
(String subjectName) Deprecated.Removes the subject with the given name.void
Policy.replaceCondition
(String name, Condition condition) Deprecated.Replaces an existing condition with the same name by the current one.void
PolicyManager.replacePolicy
(Policy policy) Deprecated.Replaces a policy object in the data store with the same policy namevoid
Policy.replaceReferral
(String name, Referral referral) Deprecated.Replaces an existing referral with the same name by the current one.void
Policy.replaceRule
(Rule rule) Deprecated.Replaces an existing rule with the same name by the current one.void
Policy.replaceSubject
(String name, Subject subject) Deprecated.Replaces an existing subject with the same name by the current one.void
Policy.replaceSubject
(String name, Subject subject, boolean exclusive) Deprecated.Replaces an existing subject with the same name by the current one.void
Rule.setActionValues
(Map actionValues) Deprecated.Sets the action names and their corresponding actions values (or permissions) for the resource or the service.void
Policy.setActive
(boolean active) Deprecated.Set the active flag for policy.void
ActionDecision.setAdvices
(Map advices) Deprecated.Setsadvices
associated with thisActionDecision
.void
Policy.setDescription
(String description) Deprecated.Sets the description for the policy.void
Deprecated.Sets the name of the policy.void
Deprecated.Sets the name for the rule.void
Rule.setResourceNames
(Set<String> resourceNames) Deprecated.Sets the resource names for which the rule has been created.void
ActionDecision.setTimeToLive
(long timeToLive) Deprecated.Sets the GMT time in milliseconds since epoch when this object is to be treated as expired.void
Deprecated.Sets the action values for the action.void
Deprecated.Stores the policy object in a persistent data store under the organization, sub-organization or a container object, specified as a parameter.ActionDecision.toString()
Deprecated.Gets a String representation of this objectPolicy.toString()
Deprecated.Gets string representation of the policy object.PolicyDecision.toString()
Deprecated.Gets a String representation of thisPolicyDecision
ResourceResult.toString()
Deprecated.Returns a string representation of this resource resultActionDecision.toXML()
Deprecated.Gets an XML representation of this objectPolicy.toXML()
Deprecated.Returns the serialized policy in XMLPolicyDecision.toXML()
Deprecated.Gets an XML representation of this objectResourceResult.toXML()
Deprecated.Returns an XML representation of this resource resultRule.toXML()
Deprecated.Returns an XML string representing the rule.ModifierConstructorDescriptionActionDecision
(String actionName, Set values) Deprecated.ConstructorActionDecision
(String actionName, Set values, Map advices, long timeToLive) Deprecated.ConstructorDeprecated.Constructs a policy given the policy name.Deprecated.Constructs a policy given the policy name and description.Deprecated.Constructs a policy given the policy name,description and a referralPolicy flag.Deprecated.Constructs a policy given the policy name , description, referralPolicy flag, and active flagDeprecated.Default constructor.PolicyEvaluator
(String serviceTypeName) Deprecated.Constructor to create aPolicyEvaluator
given theServiceType
name.PolicyManager
(SSOToken token) Deprecated.Constructor forPolicyManager
for the top (or root) organization.PolicyManager
(SSOToken token, String name) Deprecated.Constructor forPolicyManager
for the specified organization, sub organization or a container object.Deprecated.Constructor to create a rule object with rule name, service name, resource name and actions.Deprecated.Constructor to create a rule object with the service name, resource name and actions.Deprecated.Constructor to create a rule object with the service name and actions. -
Uses of Supported in com.sun.identity.sae.api
Modifier and TypeClassDescriptionclass
SecureAttrs
class forms the core api of "Secure Attributes Exchange" (SAE) feature.Modifier and TypeFieldDescriptionstatic final String
SecureAttrs.SAE_CMD_LOGOUT
SAE commandSAE_PARAM_CMD
static final String
SecureAttrs.SAE_CONFIG_CACHE_KEYS
SAE Config : Flag to indicate whether keys should be cached in memory once retrieved from the keystore.static final String
SecureAttrs.SAE_CONFIG_DATA_ENCRYPTION_ALG
SAE Config : data encryption algorithm.static final String
SecureAttrs.SAE_CONFIG_ENCRYPTION_KEY_STRENGTH
SAE Config : data encryption key strength.static final String
SecureAttrs.SAE_CONFIG_KEYSTORE_FILE
SAE Config : Location of the keystore to access keys from for asymmetric crypto.static final String
SecureAttrs.SAE_CONFIG_KEYSTORE_PASS
SAE Config : Password to open the keystrore.static final String
SecureAttrs.SAE_CONFIG_KEYSTORE_TYPE
SAE Config : keystore type.static final String
SecureAttrs.SAE_CONFIG_PRIVATE_KEY
SAE Config : Private key for asymmetric signing.static final String
SecureAttrs.SAE_CONFIG_PRIVATE_KEY_ALIAS
SAE Config : Private key alias for asymmetric signing.static final String
SecureAttrs.SAE_CONFIG_PRIVATE_KEY_PASS
SAE Config : Password to access the private key.static final String
SecureAttrs.SAE_CONFIG_PUBLIC_KEY_ALIAS
SAE Config : Public key for asymmetric signature verification.static final String
SecureAttrs.SAE_CONFIG_SHARED_SECRET
SAE Config : shared secret constant - used internally in FM.static final String
SecureAttrs.SAE_CONFIG_SIG_VALIDITY_DURATION
SAE Config : Signature validity : since timetamp on signature.static final String
SecureAttrs.SAE_CRYPTO_TYPE
Crypto types supported.static final String
SecureAttrs.SAE_CRYPTO_TYPE_ASYM
Crypto type : Symmetric : shared secret based trust between parties.static final String
SecureAttrs.SAE_CRYPTO_TYPE_SYM
Crypto type : Asymmetric : PKI based trust.static final String
SecureAttrs.SAE_PARAM_APPRETURN
SAE Parameter used to comunicate to FM where to redirect after a global logout is completed.static final String
SecureAttrs.SAE_PARAM_APPSLORETURNURL
SAE Parameter used to communicate to SP to return to specified url upon Logout completion.static final String
SecureAttrs.SAE_PARAM_AUTHLEVEL
SAE Parameter representing the session's authentication level.static final String
SecureAttrs.SAE_PARAM_CMD
SAE Parameter representing a command.static final String
SecureAttrs.SAE_PARAM_DATA
HTTP parameter name used to send and receive secure attribute data.static final String
SecureAttrs.SAE_PARAM_ERROR
SAE Parameter used to comunicate errors.static final String
SecureAttrs.SAE_PARAM_IDPAPPURL
SAE Parameter used to identify the IDP app (Asserting party) IDP : populates this parameter to identify itself.static final String
SecureAttrs.SAE_PARAM_SIGN
SAE Parameter internally used by FM for storing signature data.static final String
SecureAttrs.SAE_PARAM_SPAPPURL
SAE Parameter representing the requested SP app to be invoked.static final String
SecureAttrs.SAE_PARAM_TS
SAE Parameter internally used by FM for storing token timestamp.static final String
SecureAttrs.SAE_PARAM_USERID
SAE Parameter representing the authenticated user.Modifier and TypeMethodDescriptionvoid
SecureAttrs.addPublicKey
(String pubkeyalias, X509Certificate x509certificate) This interface allows to register a public key to be used for signature verification.SecureAttrs.getEncodedString
(Map<String, String> attrs, String secret) Returns a Base64 encoded string comprising a signed set of attributes.Returns encrypted string for the given attributes.static SecureAttrs
SecureAttrs.getInstance
(String name) Returns an instance to perform crypto operations.SecureAttrs.getRawAttributesFromEncodedData
(String str) Returns a decodedMap
of attribute-value pairs.SecureAttrs.getRawAttributesFromEncodedData
(String str, String encSecret) Returns a decodedMap
of attribute-value pairs.SecureAttrs.getSignedString
(Map<String, String> attrs, String secret) Returns a String representing data in the attrs argument.static void
SecureAttrs.init
(String name, String type, Properties properties) Initializes a SecureAttrs instance specified byname
.static void
SecureAttrs.init
(Properties properties) Creates two instances ofSecureAttrs
named "symmetric" and "asymmetric" representing the two suppported crytp types.void
SecureAttrs.setPrivateKey
(PrivateKey privatekey) This interface allows to set the private to be used for signing as an alternative to passing downSAE_CONFIG_PRIVATE_KEY_ALIAS
viainit
.boolean
Verifies the authenticity of data the attrs argument based on the token presented.SecureAttrs.verifyEncodedString
(String str, String secret) Verifies a Base64 encoded string for authenticity based on the shared secret supplied.SecureAttrs.verifyEncodedString
(String str, String secret, String encSecret) Verifies the encrypted data string using encryption secret and shared secret that was used for signing. -
Uses of Supported in com.sun.identity.saml.common
Modifier and TypeClassDescriptionfinal class
This is a common class defining some constants common to all SAML elements.class
This class contains some utility methods for processing SAML protocols.Modifier and TypeFieldDescriptionstatic final String
SAMLConstants.ACTION_NAMESPACE
String used in theActionNamespace
attribute to refer to common sets of actions to perform on resources.static final String
SAMLConstants.ACTION_NAMESPACE_GHPP
String used in theActionNamespace
attribute to refer to common sets of actions to perform on resources.static final String
SAMLConstants.ACTION_NAMESPACE_NEGATION
String used in theActionNamespace
attribute to refer to common sets of actions to perform on resources.static final String
SAMLConstants.ACTION_NAMESPACE_UNIX
String used in theActionNamespace
attribute to refer to common sets of actions to perform on resources.static final String
SAMLConstants.ALGO_ID_C14N_EXCL_OMIT_COMMENTS
Exclusive XML canonicalization Algorithm URI.static final String
SAMLConstants.ALGO_ID_C14N_EXCL_WITH_COMMENTS
Exclusive XML canonicalization with comments Algorithm URI.static final String
SAMLConstants.ALGO_ID_C14N_OMIT_COMMENTS
XML canonicalization Algorithm URI.static final String
SAMLConstants.ALGO_ID_C14N_WITH_COMMENTS
XML canonicalization with comments Algorithm URI.static final String
SAMLConstants.ALGO_ID_MAC_HMAC_NOT_RECOMMENDED_MD5
MAC Algorithm HMAC-MD5 URI.static final String
SAMLConstants.ALGO_ID_MAC_HMAC_RIPEMD160
MAC Algorithm HMAC-RIPEMD160 URI.static final String
SAMLConstants.ALGO_ID_MAC_HMAC_SHA1
MAC Algorithm HMAC-SHA1 URI - Required.static final String
SAMLConstants.ALGO_ID_MAC_HMAC_SHA256
MAC Algorithm HMAC-SHA256 URI.static final String
SAMLConstants.ALGO_ID_MAC_HMAC_SHA384
MAC Algorithm HMAC-SHA384 URI.static final String
SAMLConstants.ALGO_ID_MAC_HMAC_SHA512
MAC Algorithm HMAC-SHA512 URI.static final String
SAMLConstants.ALGO_ID_SIGNATURE_DSA
Signature Algorithm DSAwithSHA1 URI - Required.static final String
SAMLConstants.ALGO_ID_SIGNATURE_DSA_256
Signature Algorithm DSAwithSHA1 URI - Required.static final String
SAMLConstants.ALGO_ID_SIGNATURE_NOT_RECOMMENDED_RSA_MD5
Signature Algorithm RSA-MD5 URI.static final String
SAMLConstants.ALGO_ID_SIGNATURE_RSA
Signature Algorithm RSAwithSHA1 URI - Recommended.static final String
SAMLConstants.ALGO_ID_SIGNATURE_RSA_RIPEMD160
Signature Algorithm RSA-RIPEMD160 URI.static final String
SAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA1
Signature Algorithm RSAwithSHA1 URI.static final String
SAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA256
Signature Algorithm RSA-SHA256 URI.static final String
SAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA384
Signature Algorithm RSA-SHA384 URI.static final String
SAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA512
Signature Algorithm RSA-SHA512 URI.static final String
SAMLConstants.assertionSAMLNameSpaceURI
SAML assertion namespace URI.static final String
SAMLConstants.CONFIRMATION_METHOD_BEARER
SAML Bearer confirmation method identifier URI.static final String
SAMLConstants.CONFIRMATION_METHOD_HOLDEROFKEY
SAML "Holder of Key" confirmation method identifier URI.static final String
SAMLConstants.NS_SEC
SOAP security namespace.static final String
SAMLConstants.NS_WSSE
SOAP utility namespace.static final String
SAMLConstants.NS_WSU
Liberty security namespace.static final String
SAMLConstants.NS_XMLNS
XML schema namespace.static final String
SAMLConstants.SOAP_URI
SOAP 1.1 namespace URI.static final String
SAMLConstants.TRANSFORM_BASE64_DECODE
Base64 decoding Transform URI.static final String
SAMLConstants.TRANSFORM_C14N_EXCL_OMIT_COMMENTS
Exclusive XML canonicalization Transform URI.static final String
SAMLConstants.TRANSFORM_C14N_EXCL_WITH_COMMENTS
Exclusive XML canonicalization with comments Transform URI.static final String
SAMLConstants.TRANSFORM_C14N_OMIT_COMMENTS
XML canonicalization Transform URI.static final String
SAMLConstants.TRANSFORM_C14N_WITH_COMMENTS
XML canonicalization with comments Transform URI.static final String
SAMLConstants.TRANSFORM_ENVELOPED_SIGNATURE
Enveloped Signature Transform URI.static final String
SAMLConstants.TRANSFORM_XPATH
XPath Transform URI.static final String
SAMLConstants.TRANSFORM_XPATH2FILTER
XPath Filter v2.0 Transform URI.static final String
SAMLConstants.TRANSFORM_XPATH2FILTER04
XPath Filter v2.0 Transform URI.static final String
SAMLConstants.TRANSFORM_XPATHFILTERCHGP
XPath Filter v2.0 CHGP Transform URI.static final String
SAMLConstants.TRANSFORM_XPOINTER
XPointer Transform URI.static final String
SAMLConstants.TRANSFORM_XSLT
XSLT Transform URI.static final String
SAMLConstants.XMLSIG_NAMESPACE_URI
XML Digital Signature namespace. -
Uses of Supported in com.sun.identity.saml2.common
Modifier and TypeClassDescriptionclass
TheSAML2Utils
contains utility methods for SAML 2.0 implementation.Modifier and TypeMethodDescriptionstatic String
SAML2Utils.getReverseProxyUrl
(String realm, String idpEntityId) Retrieves the reverse proxy URL configured for the specified IDP.static com.sun.identity.saml2.meta.SAML2MetaManager
SAML2Utils.getSAML2MetaManager()
Returns an instance ofSAML2MetaManger
.static com.sun.identity.saml2.meta.SAML2MetaManager
SAML2Utils.getSAML2MetaManagerWithToken
(Object token) Returns an instance ofSAML2MetaManger
. -
Uses of Supported in com.sun.identity.saml2.meta
Modifier and TypeClassDescriptionfinal class
TheSAML2MetaUtils
provides metadata related util methods.Modifier and TypeMethodDescriptionstatic String
SAML2MetaUtils.getMetaAliasByUri
(String uri) Returns metaAlias embedded in uri.static String
SAML2MetaUtils.getRealmByMetaAlias
(String metaAlias) Returns the realm by parsing the metaAlias. -
Uses of Supported in com.sun.identity.saml2.profile
Modifier and TypeClassDescriptionclass
This class provides methods to send or processAssertionIDRequest
.class
This class provides methods to send or processAttributeQuery
.class
This class provides methods to send or processAuthnQuery
.class
This class provides methods to send or processNameIDMappingRequest
.class
This class is used by a service provider (SP) to process the response from an identity provider for the SP's Assertion Consumer Service.class
This class provides methods to send or processAttributeQuery
.Modifier and TypeMethodDescriptionAttributeQueryUtil.getAttributesForFedlet
(String spEntityID, String idpEntityID, String nameIDValue, List<String> attrsList, String attrQueryProfileAlias, String subjectDN) Sends the AttributeQuery to specified attribute authority, validates the response and returns the attribute mapMap<String, Set<String>>
to the Fedletstatic String
XACMLQueryUtil.getPolicyDecisionForFedlet
(javax.servlet.http.HttpServletRequest request, String pepEntityID, String pdpEntityID, String nameIDValue, String serviceName, String resource, String action) Sends the XACML query to specifiied PDP, gets the policy decision and sends it back to the Fedletstatic NameIDMappingResponse
NameIDMapping.initiateNameIDMappingRequest
(Object session, String realm, String spEntityID, String idpEntityID, String targetSPEntityID, String targetNameIDFormat, Map paramsMap) Parses the request parameters and builds the NameIDMappingRequest to sent to remote identity provider.static Map
SPACSUtils.processResponseForFedlet
(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, PrintWriter out) Processes response from Identity Provider to Fedlet (SP).static Response
AssertionIDRequestUtil.sendAssertionIDRequest
(AssertionIDRequest assertionIDRequest, String samlAuthorityEntityID, String role, String realm, String binding) Sends theAssertionIDRequest
to specifiied Assertion ID Request Service and returnsResponse
coming from the Assertion ID Request Service.static Assertion
AssertionIDRequestUtil.sendAssertionIDRequestURI
(String assertionID, String samlAuthorityEntityID, String role, String realm) Sends the Assertion ID to specifiied Assertion ID Request Service and returnsAssertion
coming from the Assertion ID Request Service.static Response
AttributeQueryUtil.sendAttributeQuery
(AttributeQuery attrQuery, String attrAuthorityEntityID, String realm, String attrQueryProfile, String attrProfile, String binding) Sends theAttributeQuery
to specified attribute authority and returnsResponse
coming from the attribute authority.static void
AttributeQueryUtil.sendAttributeQuery
(AttributeQuery attrQuery, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String attrAuthorityEntityID, String realm, String attrQueryProfile, String attrProfile, String binding) Sends theAttributeQuery
to specified attribute authority and returnsResponse
coming from the attribute authority.static Response
AuthnQueryUtil.sendAuthnQuery
(AuthnQuery authnQuery, String authnAuthorityEntityID, String realm, String binding) This method sends theAuthnQuery
to specifiied authentication authority and returnsResponse
coming from the authentication authority. -
Uses of Supported in com.sun.identity.sm
Modifier and TypeClassDescriptionclass
The classServiceConfigurationManager
provides interfaces to manage the service's configuration data.class
TheServiceManager
class provides methods to register/remove services and to list currently registered services.class
The classServiceSchemaManager
provides interfaces to manage the service's schema.class
The classSMSThreadPool
provides interfaces to manage notification thread pools shared by idm and sm.Modifier and TypeMethodDescriptionvoid
ServiceConfigManager.addConfiguration
(InputStream in) Adds instances, global and organization configurationsServiceConfigManager.addListener
(ServiceListener listener) Registers for changes to service's configuration.ServiceSchemaManager.addListener
(ServiceListener listener) Registers for changes to service's schema.void
ServiceManager.clearCache()
Removes all the SMS cached entries.ServiceConfigManager.createGlobalConfig
(Map<String, Set<String>> attrs) Creates global configuration for the default instance of the service given the configuration attributes.ServiceConfigManager.createGlobalConfig
(Map<String, Set<String>> attrs, org.forgerock.openam.services.datastore.DataStoreId dataStoreId) Creates global configuration for the default instance of the service given the configuration attributes.ServiceConfigManager.createOrganizationConfig
(String orgName, org.forgerock.openam.sm.ConfigurationAttributes attrs, org.forgerock.openam.services.datastore.DataStoreId dataStoreId) Creates organization configuration for the default instance of the service given configuration attributes.void
ServiceConfigManager.deleteOrganizationConfig
(String orgName) Deletes the organization configuration data for the given organization.boolean
Compares this object with the given object.ServiceManager.getConfigManager
(String serviceName, String version) Returns theServiceConfigManager
for the given service name and version.ServiceSchemaManager.getDynamicSchema()
Returns the dynamic service configuration schema.ServiceConfigManager.getGlobalConfig
(String instanceName) Returns the global configuration for the given service instance.ServiceConfigManager.getGlobalConfig
(String instanceName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId) Returns the global configuration for the given service instance.ServiceSchemaManager.getGlobalSchema()
Returns the global service configuration schema.ServiceConfigManager.getGroupNames()
Returns the configuration group namesServiceSchemaManager.getI18NFileName()
Returns the I18N properties file name for the service.ServiceSchemaManager.getI18NJarURL()
Returns the URL of the JAR file that contains the I18N properties file.ServiceSchemaManager.getI18NKey()
Returns i18nKey of the schema.ServiceConfigManager.getInstance
(String instanceName) Returns the service instance given the instance nameServiceConfigManager.getInstanceNames()
Returns the service instance namesServiceConfigManager.getInstanceNames
(org.forgerock.openam.services.datastore.DataStoreId dataStoreId) ServiceConfigManager.getName()
Returns the name of the service.ServiceSchemaManager.getName()
Returns the name of the service.ServiceConfigManager.getOrganizationConfig
(String orgName, String instanceName) Returns the organization configuration for the given organization and instance name.ServiceConfigManager.getOrganizationConfig
(String orgName, String instanceName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId) Returns the organization configuration for the given organization and instance name.ServiceSchemaManager.getOrganizationSchema()
Returns the organization service configuration schema.ServiceSchemaManager.getPolicySchema()
Returns the policy service configuration schema.ServiceSchemaManager.getPropertiesViewBeanURL()
Returns URL of the view bean for the serviceServiceSchemaManager.getResourceName()
Returns the service's resource name for CREST representation, or the service name if a resource name is not defined.ServiceSchemaManager.getSchema()
Returns the service schema in XML for this service.ServiceSchemaManager.getSchema
(SchemaType type) Returns the configuration schema for the given schema typeReturns the configuration schema for the given schema typeServiceManager.getSchemaManager
(String serviceName, String version) Returns theServiceSchemaManager
for the given service name and version.ServiceSchemaManager.getSchemaTypes()
Returns the schema types available with this service.ServiceSchemaManager.getServiceAttributeNames
(SchemaType type) Returns the attribute schemas for the given schema type excluding status and service identifier attributes.ServiceSchemaManager.getServiceHierarchy()
Returns the service's hierarchy.ServiceManager.getServiceNames()
Returns all the service names that have been registered.ServiceManager.getServiceVersions
(String serviceName) Returns all versions supported by the service.ServiceSchemaManager.getUserSchema()
Returns the user service configuration schema.ServiceConfigManager.getVersion()
Returns the service version.ServiceSchemaManager.getVersion()
Returns the version of the service.ServiceManager.registerServices
(InputStream xmlServiceSchema) Registers one or more services, defined by the XML input stream that follows the SMS DTD.void
ServiceConfigManager.removeGlobalConfiguration
(String groupName) Deletes the global configuration data for the given group name.void
ServiceConfigManager.removeInstance
(String instanceName) Removes the instance form the servicevoid
ServiceConfigManager.removeListener
(String listenerID) Removes the listener from the service for the given listener ID.void
ServiceSchemaManager.removeListener
(String listenerID) Removes the listener from the service for the given listener ID.void
ServiceConfigManager.removeOrganizationConfiguration
(String orgName, String groupName) Deprecated.void
ServiceConfigManager.removeOrganizationConfiguration
(String orgName, String groupName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId) Deletes the organization's group configuration data.void
ServiceManager.removeService
(String serviceName, String version) Removes the service schema and configuration for the given service name.void
ServiceSchemaManager.replaceSchema
(InputStream xmlServiceSchema) Replaces the existing service schema with the given schema defined by the XML input stream that follows the SMS DTD.static void
SMSThreadPool.scheduleTask
(Runnable task) Schedule a task forSMSThreadPool
to run.void
ServiceSchemaManager.setI18NFileName
(String url) Sets the I18N properties file name for the servicevoid
ServiceSchemaManager.setI18NJarURL
(String url) Sets the URL of the JAR file that contains the I18N propertiesvoid
ServiceSchemaManager.setI18NKey
(String i18nKey) Sets the i18nKey of the schema.void
ServiceSchemaManager.setPropertiesViewBeanURL
(String url) Sets the URL of the view bean for the service.void
ServiceSchemaManager.setResourceName
(String name) Sets the service's resource name for CREST representation.void
ServiceSchemaManager.setServiceHierarchy
(String newhierarchy) Sets the service's hierarchyServiceConfigManager.toString()
Returns String representation of the service's configuration data, along with instances and groups.ServiceSchemaManager.toString()
Returns the string representation of the Service Schema.ModifierConstructorDescriptionServiceConfigManager
(SSOToken token, String serviceName, String version) Creates an instance ofServiceConfigManager
for the given service and version.ServiceManager
(SSOToken token) Creates an instance ofServiceManager
.ServiceSchemaManager
(SSOToken token, String serviceName, String version, org.forgerock.openam.services.datastore.DataStoreId dataStoreId, boolean isSaved) Creates an instance ofServiceSchemaManager
for the given service and version pair. -
Uses of Supported in org.forgerock.oauth2.core
Modifier and TypeClassDescriptionenum
Identifies the OAuth2 Authorization Grant (aka OAuth2 Flow) undertaken to obtain an OAuth2 token.interface
An abstraction of the actual request so as to allow the core of the OAuth2 provider to be agnostic of the library used to translate the HTTP request.Modifier and TypeMethodDescriptionOAuth2Request.getAttribute
(String name) Gets the value for an attribute from the request with the specified name.OAuth2Request.getBody()
Gets the body of the request.org.forgerock.oauth2.core.Client
OAuth2Request.getClient()
Gets the client associated with this request, or null if not yet set.org.forgerock.oauth2.core.ClientRegistration
OAuth2Request.getClientRegistration()
Get the OAuth2 client registration of the request.OAuth2Request.getConsentResponseJwt()
OAuth2Request.getLocale()
Get the request locale.OAuth2Request.getOps()
Gets the user's session public reference for this request.<T> T
OAuth2Request.getParameter
(String name) Gets the specified parameter from the request.<T> T
OAuth2Request.getParameter
(String name, boolean checkQueryParam) Gets the specified parameter from the request.int
OAuth2Request.getParameterCount
(String name) Gets the count of the parameter present in the request with the given nameOAuth2Request.getParameterNames()
Gets the name of the parameters in the current requestOAuth2Request.getQueryParameter
(String name) Gets the value for a query parameter from the request with the specified name.OAuth2Request.getRequest()
Gets the actual underlying request.OAuth2Request.getSession()
Gets the user's session for this request.OAuth2Request.getSid()
Gets the session's OIDC Session ID for this request.<T extends Token>
TGet a Token that is in play for this request.OAuth2Request.getTokens()
Get all the tokens that have been used in this request.void
OAuth2Request.setClient
(org.forgerock.oauth2.core.Client client) Sets the client associated with this request.void
OAuth2Request.setClientRegistration
(org.forgerock.oauth2.core.ClientRegistration clientRegistration) Set the OAuth2 client registration.void
OAuth2Request.setConsentResponseJwt
(SignedJwt jwt) void
Sets the user's session public reference for this request.void
OAuth2Request.setSession
(String sessionId) Sets the user's session for this request.void
Sets the session's OIDC Session ID for this request.<T extends Token>
voidSet a Token that is in play for this request. -
Uses of Supported in org.forgerock.oauth2.core.plugins
Modifier and TypeInterfaceDescriptioninterface
A plugin or (extension point) that allows modification of the OAuth2 access token before the token is persisted/returned to the client.interface
A plugin or (extension point) that allows the OAuth2 provider to return additional data from an authorization request.interface
A plugin or (extension point) that evaluates and returns an OAuth2 access token's scope information.interface
A plugin or (extension point) that allows the OAuth2 provider to customise the set of requested scopes for authorize, access token, refresh token and back channel authorize requests.interface
A plugin or (extension point) that fetches the resource owners information based on an issued access token.Modifier and TypeMethodDescriptionScopeEvaluator.evaluateScope
(AccessToken accessToken) Gets the specified access token's information related to a scope.UserInfoClaimsPlugin.getUserInfo
(org.forgerock.oauth2.core.ClientRegistration clientRegistration, AccessToken token, OAuth2Request request) Gets the resource owners information based on an issued access token.void
AccessTokenModifier.modifyAccessToken
(AccessToken accessToken, OAuth2Request request) An extension point that allows modification of the OAuth2 access token before the token is persisted/returned to the client.AuthorizeEndpointDataProvider.provide
(Map<String, Token> tokens, OAuth2Request request) Provided as an extension point to allow the OAuth2 provider to return additional data from an authorization request.ScopeValidator.validateAccessTokenScope
(org.forgerock.oauth2.core.ClientRegistration clientRegistration, Set<String> scope, OAuth2Request request) Provided as an extension point to allow the OAuth2 provider to customise the scopes requested when an access token is requested.ScopeValidator.validateAuthorizationScope
(org.forgerock.oauth2.core.ClientRegistration clientRegistration, Set<String> scope, OAuth2Request request) Provided as an extension point to allow the OAuth2 provider to customise the scopes requested when authorization is requested.ScopeValidator.validateBackChannelAuthorizationScope
(org.forgerock.oauth2.core.ClientRegistration clientRegistration, Set<String> requestedScopes, OAuth2Request request) Provided as an extension point to allow the OAuth2 provider to customize the scopes requested when performing a client initiated back channel authentication.ScopeValidator.validateRefreshTokenScope
(org.forgerock.oauth2.core.ClientRegistration clientRegistration, Set<String> requestedScope, Set<String> tokenScope, OAuth2Request request) Provided as an extension point to allow the OAuth2 provider to customise the scopes requested when a refresh token is requested. -
Uses of Supported in org.forgerock.openam.annotations.sm
Modifier and TypeClassDescription@interface
Indicates that a method contains rich sub-configuration(s) of the parent configuration (or sub-configuration). -
Uses of Supported in org.forgerock.openam.auth.nodes.script
Modifier and TypeClassDescriptionclass
A wrapper class to support the generation of JWT assertions within scripts.class
A wrapper class to support the validation of JWTs within scripts. -
Uses of Supported in org.forgerock.openam.ldap
Modifier and TypeClassDescriptionfinal class
Utility methods to help interaction with the OpenDJ LDAP SDK.static class
A model object that contains the settings used for cached connection pools.static class
Simple failover Ldap Client.Modifier and TypeFieldDescriptionLDAPUtils.AFFINITY_ENABLED
AnOption
that tells whether affinity based load balancing is enabled for the connections.static final Option<LDAPUtils.CachedPoolOptions>
LDAPUtils.CACHED_POOL_OPTIONS
AnOption
that stores the settings related to cached connection pooling.Modifier and TypeMethodDescriptionstatic void
LDAPUtils.addAttributeToMapAsByteArray
(Attribute attribute, Map<String, byte[][]> map) Converts the Attribute to an attribute name, 2-dimensional byte array map and adds it to the map passed in.static void
Converts the Attribute to an attribute name, set of String values map and adds it to the map passed in.LDAPUtils.collectNonIdenticalValues
(Dn compare, Set<String> dns) Returns a set of all the non-root DNs from the collection that are not equal to thecompare
parameter.static Set<org.forgerock.openam.ldap.LDAPURL>
LDAPUtils.convertToLDAPURLs
(Set<String> servers) Converts the incoming set of URLs toLDAPURL
instances and returns them as a set.static ConnectionFactory
LDAPUtils.createFailoverConnectionFactory
(String host, int defaultPort, boolean ssl, String authDN, String authPasswd, boolean mtlsEnabled, String mtlsSecretId, Realm realm, Secrets secrets, Options options) Creates a ConnectionFactory from the host string and associated details.static ConnectionFactory
LDAPUtils.createFailoverConnectionFactory
(String host, int defaultPort, boolean ssl, String authDN, String authPasswd, Options options) Creates a ConnectionFactory from the host string and associated details.static boolean
Determines if the DN's are equal.static String
LDAPUtils.escapeValue
(String str) Escapes characters that should be escaped.static String
LDAPUtils.formatToRFC
(String dn) Converts a DN String to a RFC format and lowers case.LDAPUtils.getAttributeValuesAsStringSet
(Attribute attribute) Converts all the attribute values to a String Set.static String
LDAPUtils.getDBName
(String suffix, Connection ld) Gets the DB name.static Set<org.forgerock.openam.ldap.LDAPURL>
LDAPUtils.getLdapUrls
(String serverName, int port, boolean isSSL) Converts the serverName, port and ssl into LDAPURL and add it into a Set.static Set<org.forgerock.openam.ldap.LDAPURL>
LDAPUtils.getLdapUrls
(Set<org.forgerock.openam.ldap.LDAPURL> ldapServers, boolean isSSL) Converts the ldapServers and ssl into LDAPURL and add it into a Set.static String
Returns the RDN without the attribute name from the passed inDn
object, for example:uid=demo,ou=people,dc=example,dc=com
will returndemo
.static SearchScope
LDAPUtils.getSearchScope
(String scope, SearchScope defaultScope) Converts string representation of scope (as defined in the configuration) to the correspondingSearchScope
object.static boolean
Tests whether the supplied string is a DN, and is not the root DN.static Dn
Creates a DN from the specified DN string.static ConnectionFactory
LDAPUtils.newFailoverConnectionFactory
(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTls, boolean sslTrustAll, boolean mtlsEnabled, String mtlsSecretId, Realm realm, Secrets secrets, Options ldapOptions) Creates a new connection factory that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newFailoverConnectionFactory
(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTls, boolean sslTrustAll, Options ldapOptions) Creates a new connection factory that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newFailoverConnectionPool
(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions) Creates a new connection pool that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newFailoverConnectionPool
(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions, boolean mtlsEnabled, String mtlsSecretId, Secrets secrets, Realm realm) Creates a new connection pool that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newFailoverConnectionPool
(Set<org.forgerock.openam.ldap.LDAPURL> primaryUrls, Set<org.forgerock.openam.ldap.LDAPURL> secondaryUrls, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, boolean mtlsEnabled, String mtlsCertificateLabel, Realm realm, Secrets secrets, Options ldapOptions) Creates a new connection pool that is capable to failover from the primary to the secondary servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newFailoverConnectionPool
(Set<org.forgerock.openam.ldap.LDAPURL> primaryUrls, Set<org.forgerock.openam.ldap.LDAPURL> secondaryUrls, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions) Creates a new connection pool that is capable to failover from the primary to the secondary servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newNamedConnectionFactory
(ConnectionFactory factory, String name) Creates a new connection factory which forwards connection requests to the provided factory, but whosetoString
method will always returnname
.static ConnectionFactory
LDAPUtils.newPasswordConnectionFactory
(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions) Creates a new connection pooled connection factory that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newPasswordConnectionFactory
(Set<org.forgerock.openam.ldap.LDAPURL> primaryServers, Set<org.forgerock.openam.ldap.LDAPURL> secondaryServers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions) Creates a new connection pooled connection factory that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newPrioritizedFailoverConnectionFactory
(Set<String> servers, String hostServerId, String hostSiteId, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options options) Based on the incoming parameters prioritizes the LDAP server list, then creates a connection factory that is capable to failover to the servers defined in case there is an error.static ConnectionFactory
LDAPUtils.newPrioritizedFailoverConnectionPool
(Set<String> servers, String hostServerId, String hostSiteId, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions) Based on the incoming parameters prioritizes the LDAP server list, then creates a connection pool that is capable to failover to the servers defined in case there is an error.static String
LDAPUtils.normalizeDN
(String dn) Normalizes the DN.static Filter
LDAPUtils.parseFilter
(String filter, Filter defaultFilter) Parses the incoming filter, and in case of failure falls back to the default filter.static String
LDAPUtils.partiallyEscapeAssertionValue
(String assertionValue, boolean allowWildCards) Escapes the provided assertion value according to the LDAP standard.static Set<org.forgerock.openam.ldap.LDAPURL>
LDAPUtils.prioritizeServers
(Set<String> servers, String hostServerId, String hostSiteId) Prioritizes the incoming LDAP servers based on their assigned servers/sites.static String
When provided an RDN, returns the attribute type name.static String
LDAPUtils.rdnTypeFromDn
(String dn) When provided a DN, returns the attribute type name of the first RDN.static String
LDAPUtils.rdnTypeFromDn
(Dn dn) When provided a DN, returns the attribute type name of the first RDN.static String
When provided an RDN, returns the value part.static String
LDAPUtils.rdnValueFromDn
(String dn) When provided a DN, returns the value part of the first RDN.static String
LDAPUtils.rdnValueFromDn
(Dn dn) When provided a DN, returns the value part of the first RDN. -
Uses of Supported in org.forgerock.openam.scripting.api.identity
Modifier and TypeClassDescriptionclass
A wrapper class to limit an authentication script's exposure to a AmIdentity objectclass
A repository to retrieve user information within a scripting module's scriptModifier and TypeMethodDescriptionvoid
ScriptedIdentity.addAttribute
(String attributeName, String attributeValue) Adds a new attribute value to the existing set for the named attribute.String[]
ScriptedIdentity.getAttributeValues
(String attributeName) Retrieves a particular attribute's valueScriptedIdentityRepository.getIdentity
(String userName) Retrieves the attributes associated with a particular uservoid
ScriptedIdentity.setAttribute
(String attributeName, String[] attributeValues) Sets the attribute's values. -
Uses of Supported in org.forgerock.openam.scripting.api.secrets
Modifier and TypeClassDescriptionclass
A wrapper around the Secrets API that allows a simplified interface to access secrets from a scripting context.Modifier and TypeMethodDescriptionScriptedSecrets.getGenericSecret
(String secretId) Allows the caller to access a generic type of secret from the Secrets API.ModifierConstructorDescriptionScriptedSecrets
(Secrets secrets, Realm realm) Constructor.ScriptedSecrets
(Secrets secrets, Realm realm, Set<String> validPrefixes) Constructor. -
Uses of Supported in org.forgerock.openam.scripting.wrappers
Modifier and TypeClassDescriptionclass
An Exception thrown by theHttpClientScriptWrapper
which can be used for logging purposes in scripts.class
A wrapper class to simplify sending HTTP requests in scripts.class
A class providing an "openidm" object in JS scripts running within AM, which calls CRUDPAQ endpoints of the configured IDM instance.Modifier and TypeMethodDescriptionPerforms an action on an object.IdmIntegrationServiceScriptWrapper.action
(String resource, String actionName, Map<String, Object> content) Performs an action on an object.IdmIntegrationServiceScriptWrapper.action
(String resource, String actionName, Map<String, Object> content, Map<String, Object> params) Performs an action on an object.IdmIntegrationServiceScriptWrapper.action
(String resource, String actionName, Map<String, Object> content, Map<String, Object> params, List<Object> fields) Performs an action on an object.IdmIntegrationServiceScriptWrapper.create
(String resourceName, String newResourceId, Map<String, Object> content) Creates a new object in IDM.IdmIntegrationServiceScriptWrapper.create
(String resourceName, String newResourceId, Map<String, Object> content, Map<String, Object> params) Creates a new object in IDM.IdmIntegrationServiceScriptWrapper.create
(String resourceName, String newResourceId, Map<String, Object> content, Map<String, Object> params, List<Object> fields) Creates a new object in IDM.Deletes an object.IdmIntegrationServiceScriptWrapper.delete
(String resourceName, String rev, Map<String, Object> params) Deletes an object.IdmIntegrationServiceScriptWrapper.delete
(String resourceName, String rev, Map<String, Object> params, List<Object> fields) Deletes an object.Performs a partial modification of a managed or system object.IdmIntegrationServiceScriptWrapper.patch
(String resourceName, String rev, List<Object> patch, Map<String, Object> params) Performs a partial modification of a managed or system object.IdmIntegrationServiceScriptWrapper.patch
(String resourceName, String rev, List<Object> patch, Map<String, Object> params, List<Object> fields) Performs a partial modification of a managed or system object.Performs a query on the specified resource object.IdmIntegrationServiceScriptWrapper.query
(String resourceName, Map<String, Object> params, List<Object> fields) Performs a query on the specified resource object.Reads and returns a resource object.Reads and returns a resource object.IdmIntegrationServiceScriptWrapper.read
(String resourceName, Map<String, Object> params, List<Object> fields) Reads and returns a resource object.Updates an entire resource object.IdmIntegrationServiceScriptWrapper.update
(String id, String rev, Map<String, Object> value, Map<String, Object> params) Updates an entire resource object.IdmIntegrationServiceScriptWrapper.update
(String id, String rev, Map<String, Object> value, Map<String, Object> params, List<Object> fields) Updates an entire resource object. -
Uses of Supported in org.forgerock.openam.selfservice.config
Modifier and TypeInterfaceDescriptioninterface
Defines the bases for which all self service console configuration should be built on. -
Uses of Supported in org.forgerock.openam.services.email
Modifier and TypeClassDescriptionclass
DefaultMailServer
implementation that sends email via the configured SMTP server. -
Uses of Supported in org.forgerock.openam.services.email.rest
Modifier and TypeClassDescriptionclass
Sends emails over REST using the OAuth2 client credentials grant type for authentication. -
Uses of Supported in org.forgerock.openam.sm
Modifier and TypeInterfaceDescriptioninterface
A registry for all service configuration that is defined in annotated service interfaces. -
Uses of Supported in org.forgerock.openam.sm.annotations
Modifier and TypeClassDescriptionclass
Describes a service as defined by an annotated interface. -
Uses of Supported in org.forgerock.openam.upgrade
Modifier and TypeClassDescriptionclass
This class contains utilities to upgrade the service schema configuration to be compatible with OpenAM.Modifier and TypeMethodDescriptionstatic void
UpgradeUtils.addAttributeDefaultValues
(String serviceName, String subSchemaName, String schemaType, String attributeName, Set defaultValues) Adds default values to an existing attribute.static void
UpgradeUtils.addAttributeToSchema
(ServiceSchema serviceSchema, Node attributeSchemaNode) Adds new attribute schema to an existing service.static void
UpgradeUtils.addAttributeToSchema
(String serviceName, String subSchemaName, String schemaType, Node attributeSchemaNode, SSOToken adminToken) Adds new attribute schema to an existing service.static void
UpgradeUtils.addAttributeToSubSchema
(String serviceName, String subSchemaName, String schemaType, String attributeSchemaFile) Adds new attribute schema to a sub schema in an existing service.static void
UpgradeUtils.createService
(String fileName) Creates a new service schema in the configuration store.static void
UpgradeUtils.removeAttributeSchema
(ServiceSchema serviceSchema, String attributeName) Removes attribute schema from an existing service.static void
UpgradeUtils.removeAttributeSchema
(String serviceName, String subSchemaName, String schemaType, String attributeName, SSOToken adminToken) Remove an attribute schema from an existing service.static void
UpgradeUtils.replaceAttributeSchema
(ServiceSchema serviceSchema, String attributeName, Node attributeSchemaNode) Replace an attribute schema from an existing service with the new onestatic void
UpgradeUtils.replaceAttributeSchema
(String serviceName, String subSchemaName, String schemaType, String attributeName, SSOToken adminToken, Node attributeSchemaNode) Replace an attribute schema from an existing service with the new one
AMIdentityRepository(String, SSOToken)