Uses of Annotation Interface
org.forgerock.openam.annotations.Supported
Packages that use 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.
Packages with annotations of type Supported
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
Classes in com.iplanet.services.ldap.event with annotations of type SupportedModifier and TypeClassDescriptionclassclassException occurs while setting an event request or when trigering the "entryChanged()" method after a persistent search results are received from the Directory Server.classThe EventService is responsible for listening to and dispatching to listening objects messages returning from persistent searches running in an underlying LDAP implementation.interfaceThe purpose of this interface is to allow classes that implement this interface to listen to Directory Server Events.Methods in com.iplanet.services.ldap.event with annotations of type SupportedModifier and TypeMethodDescriptionvoidIDSEventListener.entryChanged(DSEvent e) This callback method is called by the EventService when the Directory Server triggers a PersistentSearch notificationvoidIDSEventListener.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 EventServiceEventService.getEventService()Returns the event service (presuming we are not in the process of shutting down).intDSEvent.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.voidEventException.printStackTrace()Prints a stack trace for this EventException to System.out;voidEventException.printStackTrace(PrintStream printStream) Prints a stack trace for this EventException to the given PrintStream;voidEventException.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);Constructors in com.iplanet.services.ldap.event with annotations of type SupportedModifierConstructorDescriptionEventException(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
Classes in com.iplanet.services.util with annotations of type SupportedModifier and TypeClassDescriptionclassTheI18nclass provides methods for applications and services to internationalize their messages.Methods in com.iplanet.services.util with annotations of type SupportedModifier and TypeMethodDescriptionstatic I18nI18n.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
Classes in com.iplanet.sso with annotations of type SupportedModifier and TypeClassDescriptionclassSSOTokenManager is the final class that is the mediator between the SSO APIs and SSO providers.Methods in com.iplanet.sso with annotations of type SupportedModifier 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 fromHttpServletRequestvoidSSOTokenManager.destroyToken(SSOToken token) Destroys a single sign on token.voidSSOTokenManager.destroyToken(SSOToken destroyer, SSOToken destroyed) Destroys a single sign on token.static SSOTokenManagerSSOTokenManager.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.booleanSSOTokenManager.isValidToken(SSOToken token) Returns true if a single sign on token is valid.booleanSSOTokenManager.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.voidSSOTokenManager.refreshSession(SSOToken token) Refresh the Session corresponding to the single sign on token from the Session Server.voidSSOTokenManager.validateToken(SSOToken token) Returns true if the single sign on token is valid. -
Uses of Supported in com.iplanet.sso.providers.dpro
Classes in com.iplanet.sso.providers.dpro with annotations of type SupportedModifier and TypeClassDescriptionfinal classThisfinalclassSSOProviderImplimplementsSSOProviderinterface and provides implementation of the methods to create , destroy , check the validity of a single sign on token.Methods in com.iplanet.sso.providers.dpro with annotations of type SupportedModifier and TypeMethodDescriptionvoidSSOProviderImpl.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.Constructors in com.iplanet.sso.providers.dpro with annotations of type Supported -
Uses of Supported in com.sun.identity.authentication
Classes in com.sun.identity.authentication with annotations of type SupportedModifier and TypeClassDescriptionclassTheAuthContextprovides the implementation for authenticating users.Methods in com.sun.identity.authentication with annotations of type SupportedModifier and TypeMethodDescriptionvoidAuthContext.abort()Terminates an ongoinglogincall 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 theAuthContextconstructor.AuthContext.getOrganizationName()Returns the the organization name that was set during theAuthContextconstructor.Callback[]AuthContext.getRequirements()Returns an array ofCallbackobjects that must be populated by the user and returned back.Callback[]AuthContext.getRequirements(boolean noFilter) Returns an array ofCallbackobjects 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.booleanAuthContext.hasMoreRequirements()Returnstrueif the login process requires more information from the user to complete the authentication.booleanAuthContext.hasMoreRequirements(boolean noFilter) Returnstrueif the login process requires more information from the user to complete the authentication.voidAuthContext.login()Starts the login process for the givenAuthContextobject.voidAuthContext.login(AuthContext.IndexType type, String indexName) Starts the login process for the givenAuthContextobject identified by the index type and index name.voidAuthContext.login(AuthContext.IndexType indexType, String indexName, String[] params) Starts the login process for the givenAuthContextobject identified by the index type and index name with default parameters.voidAuthContext.login(AuthContext.IndexType indexType, String indexName, String[] params, Map envMap) Starts the login process for the givenAuthContextobject identified by the index type and index name with certain parameters and environment map.voidAuthContext.login(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Starts the login process for the givenAuthContextobject.voidAuthContext.logout()Logs out the user and also invalidates the single sign on token associated with thisAuthContext.voidAuthContext.logoutUsingTokenID()Logs out the user and also invalidates the single sign on token associated with thisAuthContext.voidAuthContext.setClientHostName(String hostname) Sets the client's hostname or IP address.This could be used by the policy component to restrict access to resources.voidAuthContext.submitRequirements(Callback[] info) Submits the populatedCallbackobjects to the authentication plug-in modules.Constructors in com.sun.identity.authentication with annotations of type SupportedModifierConstructorDescriptionAuthContext(SSOToken ssoToken) Constructs an instance ofAuthContextfor a given organization name, or sub organization name contained in the single sign on token.AuthContext(SSOToken ssoToken, boolean forceAuth) Constructs an instance ofAuthContextfor a given organization name, or sub organization name contained in the single sign on token.AuthContext(String orgName) Constructs an instance ofAuthContextfor a given organization name or sub organization name.AuthContext(String orgName, URL url) Constructs an instance ofAuthContextfor a given organization name, or sub organization name and the OpenAM server URL. -
Uses of Supported in com.sun.identity.authentication.server
Classes in com.sun.identity.authentication.server with annotations of type SupportedModifier and TypeClassDescriptionfinal classTheAuthContextLocalprovides the implementation for authenticating users.Methods in com.sun.identity.authentication.server with annotations of type SupportedModifier and TypeMethodDescriptionvoidAuthContextLocal.abort()Terminates an ongoinglogincall 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 theAuthContextconstructor.AuthContextLocal.getOrganizationName()Returns the the organization name that was set during theAuthContextLocalconstructor.Callback[]AuthContextLocal.getRequirements()Returns an array ofCallbackobjects that must be populated by the user and returned back.Callback[]AuthContextLocal.getRequirements(boolean noFilter) Returns an array ofCallbackobjects 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.booleanAuthContextLocal.hasMoreRequirements()Checks if the login process requires more information from the user to complete the authentication.voidAuthContextLocal.login()Starts the login process for the givenAuthContextLocalobject.voidAuthContextLocal.login(AuthContext.IndexType type, String indexName) Start the login process for theAuthContextLocalobject identified by the index type and index name.voidStarts the login process for the givenAuthContextLocals object for the givenPrincipaland the user's password.voidStarts the login process for the givenAuthContextLocalobject for the givenSubject.voidAuthContextLocal.logout()Logs out the user and also invalidates theSSOTokenassociated with thisAuthContextLocal.voidAuthContextLocal.submitRequirements(Callback[] info) Submit the populatedCallbackobjects to the authentication plug-in modules.Constructors in com.sun.identity.authentication.server with annotations of type SupportedModifierConstructorDescriptionAuthContextLocal(String orgName) CreatesAuthContextLocalinstance is obtained for a given organization name, or sub organization name. -
Uses of Supported in com.sun.identity.authentication.spi
Classes in com.sun.identity.authentication.spi with annotations of type SupportedModifier and TypeClassDescriptionclassAn abstract class which implements JAAS LoginModule, it provides methods to access OpenAM services and the module xml configuration.classThis class is for handling message localization in LoginException.Methods in com.sun.identity.authentication.spi with annotations of type SupportedModifier and TypeMethodDescriptionvoidAMLoginModule.clearInfoText(int state) Clears the info text for a given callback statevoidAMLoginModule.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.intAMLoginModule.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.intAMLoginModule.getCurrentState()Returns the current state in the authentication process.AuthLoginException.getErrorCode()Returns the error code.intAMLoginModule.getFailCount(AMIdentity amIdUser) Get the number of failed login attempts for a user when account locking is enabled.javax.servlet.http.HttpServletRequestAMLoginModule.getHttpServletRequest()Returns theHttpServletRequestobject that initiated the call to this module.javax.servlet.http.HttpServletResponseAMLoginModule.getHttpServletResponse()Returns theHttpServletResponseobject 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.intAMLoginModule.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.intAMLoginModule.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 PrincipalAMLoginModule.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 uservoidAMLoginModule.incrementFailCount(String userName) Increments the fail count for the given user.abstract voidInitialize this LoginModule.booleanAMLoginModule.isAccountActive(String userName) Returns true if the named account is active, false otherwise.booleanAMLoginModule.isAccountLocked(String userName) Returns true if the named account is locked out, false otherwise.booleanAMLoginModule.isRequired(int state, int index) Checks if a Callback is required to have input.booleanAMLoginModule.isReturningPrincipalAsDn()Defines whether the principal being returned is a DN.booleanAMLoginModule.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 intAbstract method must be implemented by each login module to control the flow of the login process.voidAMLoginModule.replaceCallback(int state, int index, Callback callback) Replace Callback object for a specific state.voidAMLoginModule.resetCallback(int state, int index) Reset a Callback instance to the original Callback for the specified state and the specified index.booleanAMLoginModule.setAuthLevel(int auth_level) Sets theAuthLevelfor this session.voidAMLoginModule.setFailureID(String userID) Sets theuserIDof user who failed authentication.voidAMLoginModule.setLoginFailureURL(String url) Sets the the login failure URL for the user.voidAMLoginModule.setLoginSuccessURL(String url) Sets the the login successful URL for the user.voidAMLoginModule.setUserAttributes(Map attributeValuePairs) Sets a Map of attribute value pairs to be used when the authentication service is configured to dynamically create a user.voidAMLoginModule.setUserSessionProperty(String name, String value) Sets a property in the user session.voidAMLoginModule.substituteHeader(int state, String header) Use this method to replace the header text from the XML file with new text.voidAMLoginModule.substituteInfoText(int state, int callback, String infoText) Allows you to set the info text for a specific callback.voidAMLoginModule.validatePassword(String userPassword) Deprecated.voidAMLoginModule.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.Constructors in com.sun.identity.authentication.spi with annotations of type SupportedModifierConstructorDescriptionAuthLoginException(String message) Constructs a newAuthLoginExceptionwith the given message.AuthLoginException(String rbName, String errorCode, Object[] args) Constructs a newAuthLoginExceptionwithout a nestedThrowable.AuthLoginException(String rbName, String errorCode, Object[] args, Throwable nestedException) Constructs an instance ofAuthLoginExceptionto 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 anAuthLoginExceptionwith givenThrowable. -
Uses of Supported in com.sun.identity.entitlement
Classes in com.sun.identity.entitlement with annotations of type SupportedModifier and TypeClassDescriptionclassThe class evaluates entitlement request and provides decisions.Methods in com.sun.identity.entitlement with annotations of type SupportedModifier 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
Classes in com.sun.identity.idm with annotations of type SupportedModifier and TypeClassDescriptionclassThis class represents an Identity which needs to be managed by Access Manager.classThe classAMIdentityRepositoryrepresents an object to access the repositories in which user/role/group and other identity data is configured.final classThe class defines some static utilities used by other components like policy and authMethods in com.sun.identity.idm with annotations of type SupportedModifier and TypeMethodDescriptionintAMIdentityRepository.addEventListener(IdEventListener listener) Add anIdEventListenerto the pool of listeners.voidAMIdentity.addMember(AMIdentity identity) Adds the passed identity as a member of this identity.voidAMIdentity.addMembers(Set<AMIdentity> identities) Adds the passed identities as members of this identity.voidAMIdentity.assignService(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attributes) Assigns the service and service related attributes to the identity.voidAMIdentity.changePassword(String oldPassword, String newPassword) Changes password for the identity.static voidAMIdentityRepository.clearCache()Clear caches related to Identity repositories.AMIdentityRepository.createIdentities(IdType type, Map<String, Map<?, ?>> identityNamesAndAttrs) Create a set ofAMIdentitys.AMIdentityRepository.createIdentity(IdType type, String idName, Map attrMap) Create anAMIdentityobject.voidAMIdentityRepository.deleteIdentities(IdType type, Set identities) Delete a set of identities byIdType.voidAMIdentityRepository.deleteIdentities(Set<AMIdentity> identities) Delete a set ofAMIdentitys.booleanAMIdentityRepository.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 AMIdentityIdUtils.getIdentity(SSOToken token) static AMIdentityIdUtils.getIdentity(SSOToken token, String univId) static AMIdentityIdUtils.getIdentity(String uName, String realm) Gets the AMIdentity of a user with username equal to uName that exists in realmstatic AMIdentityIdUtils.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 realmAMIdentityobject.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 StringIdUtils.getUniversalId(AMIdentity id) booleanAMIdentity.isActive()If there is a status attribute configured, then verifies if the identity is active and returns true.booleanAMIdentity.isExists()This method determines if the identity exists and returns true or false.booleanAMIdentity.isMember(UniversalId universalId) Verifies if this identity is a member of the identity being passed.voidAMIdentity.modifyService(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attrMap) Set attributes related to a specific service.voidAMIdentity.removeAttributes(Set<String> attrNames) Removes the attributes from the identity entry.voidAMIdentityRepository.removeEventListener(int identifier) Remove anIdEventListenerfrom the pool of listeners.voidAMIdentity.removeMember(AMIdentity identity) Removes the passed identity as a member of this identity.voidAMIdentity.removeMembers(Set<AMIdentity> identities) Removes the passed identities as members of this identity.voidAMIdentity.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.voidAMIdentity.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.voidAMIdentity.setAttributes(Map attrMap) Sets the values of attributes.voidAMIdentity.setBinaryAttributes(Map attrMap) Set the values of binary attributes.voidAMIdentity.store()Stores the attributes of the object.voidAMIdentity.unassignService(String serviceName) Removes a service from the identity.Constructors in com.sun.identity.idm with annotations of type SupportedModifierConstructorDescriptionAMIdentity(SSOToken token) Constructs a newAMIdentityinstance from the passed token.AMIdentity(SSOToken token, String universalId) Constructs a newAMIdentityinstance 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
Classes in com.sun.identity.liberty.ws.common.wsse with annotations of type SupportedModifier and TypeClassDescriptionclassThe classBinarySecurityTokenprovides 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.Fields in com.sun.identity.liberty.ws.common.wsse with annotations of type SupportedModifier and TypeFieldDescriptionstatic final QNameBinarySecurityToken.BASE64BINARYTheBASE64BINARYencoding type indicates that the encoding name given corresponds to base64 encoding of a binary value.static final QNameBinarySecurityToken.HEXBINARYTheHEXBINARYencoding type indicates that the encoding name given corresponds to Hex encoding of a binary value.static final QNameBinarySecurityToken.PKCS7ThePKCS7value type indicates that the value name given corresponds to a PKCS7 object.static final QNameBinarySecurityToken.PKIPathThePKIPATHvalue type indicates that the value name given corresponds to a PKI Path object.static final QNameBinarySecurityToken.X509V3TheX509V3value type indicates that the value name given corresponds to a X509 Certificate.Methods in com.sun.identity.liberty.ws.common.wsse with annotations of type SupportedModifier 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.Constructors in com.sun.identity.liberty.ws.common.wsse with annotations of type Supported -
Uses of Supported in com.sun.identity.liberty.ws.soapbinding
Classes in com.sun.identity.liberty.ws.soapbinding with annotations of type SupportedMethods in com.sun.identity.liberty.ws.soapbinding with annotations of type SupportedModifier and TypeMethodDescriptionstatic StringUtils.BooleanToString(Boolean bool) Converts a Boolean object to a String representing XML boolean.static QNameUtils.convertStringToQName(String str, Element element) Converts a string value to a QName.static StringGets localized string from resource bundle.static BooleanUtils.StringToBoolean(String str) Converts a value of XML boolean type to Boolean object. -
Uses of Supported in com.sun.identity.log
Classes in com.sun.identity.log with annotations of type SupportedFields in com.sun.identity.log with annotations of type SupportedModifier and TypeFieldDescriptionstatic final StringLogConstants.ALL_FIELDSDeprecated.Attribute defining the set of all fields being logged.static final StringLogConstants.BACKENDDeprecated.Attribute defining whether the logs to be stored in flat-files or to a Database.static final StringLogConstants.BUFFER_SIZEDeprecated.Attribute defining the Buffer size.static final StringLogConstants.BUFFER_TIMEDeprecated.Attribute defining the Buffering time.static final StringLogConstants.CONTEXT_IDDeprecated.The ContextID field.static final StringLogConstants.CRLFDeprecated.Defines CarriageReturn/LineFeed characters.static final StringLogConstants.DATADeprecated.The Data field.static final StringLogConstants.DB_DRIVERDeprecated.Attribute defining the Database Driver.static final StringLogConstants.DB_MEM_MAX_RECSDeprecated.Attribute defining the Maximum LogRecords held in memory if DB logging fails.static final StringLogConstants.DEBUG_IMPL_CLASSDeprecated.Attribute defining the Class that implements the custom debug method in the case of log failure.static final StringLogConstants.DOMAINDeprecated.The Domain field.static final StringLogConstants.HOST_NAMEDeprecated.The HostName field.static final StringLogConstants.IP_ADDRDeprecated.The IPAddr field.static final StringLogConstants.LOG_FIELDSDeprecated.Attribute defining the fields currently selected by the administrator to be logged.static final StringLogConstants.LOG_LEVELDeprecated.The LogLevel field.static final StringLogConstants.LOG_LOCATIONDeprecated.Attribute defining the location where the logs go.static final StringLogConstants.LOG_STATUSDeprecated.Property defining whether logging is enabledstatic final StringLogConstants.LOGGED_BYDeprecated.The LoggedBy field.static final StringLogConstants.LOGGING_SERVICEDeprecated.Defines the LoggingService name.static final StringLogConstants.LOGIN_IDDeprecated.The LoginID field.static final intLogConstants.MAX_FIELDSDeprecated.The maximum number of fields in a "regular" record.static final StringLogConstants.MAX_FILE_SIZEDeprecated.Attribute defining the maximum (flat) file size, above which the files are either archived or rotated.static final StringLogConstants.MESSAGE_IDDeprecated.The MessageID field.static final StringLogConstants.MODULE_NAMEDeprecated.The ModuleName field.static final StringLogConstants.NAME_IDDeprecated.The NameID field.static final StringLogConstants.NUM_HISTORY_FILESDeprecated.Attribute defining the number of history files a (flat file) log should have.static final StringLogConstants.TIMEDeprecated.The Date/Time field.static final StringLogConstants.TIME_BUFFERING_STATUSDeprecated.Attribute defining the Time Buffering Status; ON or OFF.Methods in com.sun.identity.log with annotations of type SupportedModifier and TypeMethodDescriptionvoidLogRecord.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.voidLogRecord.setLogInfoMap(Map logInfoMap) Deprecated.Convenience method to set the log information map.Constructors in com.sun.identity.log with annotations of type Supported -
Uses of Supported in com.sun.identity.policy
Classes in com.sun.identity.policy with annotations of type SupportedModifier and TypeClassDescriptionclassDeprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlementinstead asEntitlementhas replacedPolicy.classDeprecated.As of OpenSSO Express 8.0, useEntitlementinstead asEntitlementhas replacedPolicy.classDeprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlementinstead asEntitlementhas replacedPolicy.classDeprecated.final classDeprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlementinstead asEntitlementhas replacedPolicy.classDeprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlementinstead asEntitlementhas replacedPolicy.classDeprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlementinstead asEntitlementhas replacedPolicy.Fields in com.sun.identity.policy with annotations of type SupportedModifier and TypeFieldDescriptionstatic final StringPolicyEvaluator.ALL_RESOURCESDeprecated.Constant used to identity all the resources of a service type.static final StringPolicyEvaluator.EMPTY_RESOURCE_NAMEDeprecated.Constant used to identity empty resourcestatic final StringPolicyManager.ORGANIZATION_NAMEDeprecated.The key for the plugins to get the organization name.static final StringPolicyManager.POLICY_SERVICE_NAMEDeprecated.The service name for Policy component.static final StringResourceResult.SELF_SCOPEDeprecated.Constant to indicate base (self) level scope forResourceResultevaluationstatic final StringResourceResult.STRICT_SUBTREE_SCOPEDeprecated.Constant to indicate strict subtree level scope forResourceResultevaluationstatic final StringResourceResult.SUBTREE_SCOPEDeprecated.Constant to indicate subtree level scope for ResourceResult evaluationMethods in com.sun.identity.policy with annotations of type SupportedModifier and TypeMethodDescriptionvoidPolicyDecision.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.voidPolicy.addCondition(String name, Condition condition) Deprecated.Adds a new policy condition.voidDeprecated.Adds a policy to the data store.voidPolicyEvaluator.addPolicyListener(PolicyListener policyListener) Deprecated.Adds a policy listener that would be notified whenever a policy is added, removed or changedvoidPolicy.addRealmSubject(SSOToken token, String subjectName, String realmName, boolean exclusive) Deprecated.Adds a reference in the policy to a Subject defined at the realm.voidPolicy.addRealmSubject(String subjectName, SubjectTypeManager stm, boolean exclusive) Deprecated.Adds a reference in the policy to a Subject defined at the realm.voidPolicy.addReferral(String name, Referral referral) Deprecated.Adds a new policy referral.voidDeprecated.Adds a new policy rule.voidPolicy.addSubject(String name, Subject subject) Deprecated.Adds a new policy subject.voidPolicy.addSubject(String name, Subject subject, boolean exclusive) Deprecated.Adds a new policy subject.PolicyDecision.getActionDecisions()Deprecated.Gets theMapof 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 aMapof 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 aMapofadvicesassociated 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 theConditionTypeManagerobject instance associated with thisPolicyManagerobject 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 theSetof referral names associated with the policy.PolicyManager.getReferralTypeManager()Deprecated.ReturnsReferralTypeManagerassociated with this policy manager.com.sun.identity.policy.ResourceManagerPolicyManager.getResourceManager()Deprecated.Gets theResourceManagerobject instance associated with thisPolicyManagerobject 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 theSetof subject names associated with the policy.PolicyManager.getSubjectTypeManager()Deprecated.Gets theSubjectTypeManagerobject instance associated with thisPolicyManagerobject instancelongActionDecision.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.booleanPolicy.isActive()Deprecated.Checks whether the policy is active or inactive An inactive policy is not used to make policy evaluations.booleanPolicyEvaluator.isAllowed(SSOToken token, String resourceName, String actionName, Map envParameters) Deprecated.Evaluates simple privileges of boolean type.booleanPolicy.isRealmSubject(String subjectName) Deprecated.Checks if the subjectName is a reference to a Subject defined at the realmbooleanPolicy.isReferralPolicy()Deprecated.Checks whether the policy is a referral policy.booleanPolicy.isSubjectExclusive(String subjectName) Deprecated.Checks if the subject is exclusive.voidPolicy.removeCondition(Condition condition) Deprecated.Removes theConditionobject identified by object'sequalsmethod.Policy.removeCondition(String condition) Deprecated.Removes the condition with the given name.voidPolicyManager.removePolicy(String policyName) Deprecated.Deletes a policy in the organization with the given name.voidPolicyEvaluator.removePolicyListener(PolicyListener policyListener) Deprecated.Removes a policy listener that was previously registered to receive notifications whenever a policy is added, removed or changed.voidPolicy.removeReferral(Referral referral) Deprecated.Removes theReferralobject identified by object'sequalsmethod.Policy.removeReferral(String referralName) Deprecated.Removes the referral with the given name.Policy.removeRule(String ruleName) Deprecated.Removes theRulewith the given name.voidPolicy.removeSubject(Subject subject) Deprecated.Removes theSubjectobject identified by object'sequalsmethod.Policy.removeSubject(String subjectName) Deprecated.Removes the subject with the given name.voidPolicy.replaceCondition(String name, Condition condition) Deprecated.Replaces an existing condition with the same name by the current one.voidPolicyManager.replacePolicy(Policy policy) Deprecated.Replaces a policy object in the data store with the same policy namevoidPolicy.replaceReferral(String name, Referral referral) Deprecated.Replaces an existing referral with the same name by the current one.voidPolicy.replaceRule(Rule rule) Deprecated.Replaces an existing rule with the same name by the current one.voidPolicy.replaceSubject(String name, Subject subject) Deprecated.Replaces an existing subject with the same name by the current one.voidPolicy.replaceSubject(String name, Subject subject, boolean exclusive) Deprecated.Replaces an existing subject with the same name by the current one.voidRule.setActionValues(Map actionValues) Deprecated.Sets the action names and their corresponding actions values (or permissions) for the resource or the service.voidPolicy.setActive(boolean active) Deprecated.Set the active flag for policy.voidActionDecision.setAdvices(Map advices) Deprecated.Setsadvicesassociated with thisActionDecision.voidPolicy.setDescription(String description) Deprecated.Sets the description for the policy.voidDeprecated.Sets the name of the policy.voidDeprecated.Sets the name for the rule.voidRule.setResourceNames(Set<String> resourceNames) Deprecated.Sets the resource names for which the rule has been created.voidActionDecision.setTimeToLive(long timeToLive) Deprecated.Sets the GMT time in milliseconds since epoch when this object is to be treated as expired.voidDeprecated.Sets the action values for the action.voidDeprecated.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 thisPolicyDecisionResourceResult.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.Constructors in com.sun.identity.policy with annotations of type SupportedModifierConstructorDescriptionActionDecision(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 aPolicyEvaluatorgiven theServiceTypename.PolicyManager(SSOToken token) Deprecated.Constructor forPolicyManagerfor the top (or root) organization.PolicyManager(SSOToken token, String name) Deprecated.Constructor forPolicyManagerfor 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
Classes in com.sun.identity.sae.api with annotations of type SupportedModifier and TypeClassDescriptionclassSecureAttrsclass forms the core api of "Secure Attributes Exchange" (SAE) feature.Fields in com.sun.identity.sae.api with annotations of type SupportedModifier and TypeFieldDescriptionstatic final StringSecureAttrs.SAE_CMD_LOGOUTSAE commandSAE_PARAM_CMDstatic final StringSecureAttrs.SAE_CONFIG_CACHE_KEYSSAE Config : Flag to indicate whether keys should be cached in memory once retrieved from the keystore.static final StringSecureAttrs.SAE_CONFIG_DATA_ENCRYPTION_ALGSAE Config : data encryption algorithm.static final StringSecureAttrs.SAE_CONFIG_ENCRYPTION_KEY_STRENGTHSAE Config : data encryption key strength.static final StringSecureAttrs.SAE_CONFIG_KEYSTORE_FILESAE Config : Location of the keystore to access keys from for asymmetric crypto.static final StringSecureAttrs.SAE_CONFIG_KEYSTORE_PASSSAE Config : Password to open the keystrore.static final StringSecureAttrs.SAE_CONFIG_KEYSTORE_TYPESAE Config : keystore type.static final StringSecureAttrs.SAE_CONFIG_PRIVATE_KEYSAE Config : Private key for asymmetric signing.static final StringSecureAttrs.SAE_CONFIG_PRIVATE_KEY_ALIASSAE Config : Private key alias for asymmetric signing.static final StringSecureAttrs.SAE_CONFIG_PRIVATE_KEY_PASSSAE Config : Password to access the private key.static final StringSecureAttrs.SAE_CONFIG_PUBLIC_KEY_ALIASSAE Config : Public key for asymmetric signature verification.static final StringSecureAttrs.SAE_CONFIG_SHARED_SECRETSAE Config : shared secret constant - used internally in FM.static final StringSecureAttrs.SAE_CONFIG_SIG_VALIDITY_DURATIONSAE Config : Signature validity : since timetamp on signature.static final StringSecureAttrs.SAE_CRYPTO_TYPECrypto types supported.static final StringSecureAttrs.SAE_CRYPTO_TYPE_ASYMCrypto type : Symmetric : shared secret based trust between parties.static final StringSecureAttrs.SAE_CRYPTO_TYPE_SYMCrypto type : Asymmetric : PKI based trust.static final StringSecureAttrs.SAE_PARAM_APPRETURNSAE Parameter used to comunicate to FM where to redirect after a global logout is completed.static final StringSecureAttrs.SAE_PARAM_APPSLORETURNURLSAE Parameter used to communicate to SP to return to specified url upon Logout completion.static final StringSecureAttrs.SAE_PARAM_AUTHLEVELSAE Parameter representing the session's authentication level.static final StringSecureAttrs.SAE_PARAM_CMDSAE Parameter representing a command.static final StringSecureAttrs.SAE_PARAM_DATAHTTP parameter name used to send and receive secure attribute data.static final StringSecureAttrs.SAE_PARAM_ERRORSAE Parameter used to comunicate errors.static final StringSecureAttrs.SAE_PARAM_IDPAPPURLSAE Parameter used to identify the IDP app (Asserting party) IDP : populates this parameter to identify itself.static final StringSecureAttrs.SAE_PARAM_SIGNSAE Parameter internally used by FM for storing signature data.static final StringSecureAttrs.SAE_PARAM_SPAPPURLSAE Parameter representing the requested SP app to be invoked.static final StringSecureAttrs.SAE_PARAM_TSSAE Parameter internally used by FM for storing token timestamp.static final StringSecureAttrs.SAE_PARAM_USERIDSAE Parameter representing the authenticated user.Methods in com.sun.identity.sae.api with annotations of type SupportedModifier and TypeMethodDescriptionvoidSecureAttrs.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 SecureAttrsSecureAttrs.getInstance(String name) Returns an instance to perform crypto operations.SecureAttrs.getRawAttributesFromEncodedData(String str) Returns a decodedMapof attribute-value pairs.SecureAttrs.getRawAttributesFromEncodedData(String str, String encSecret) Returns a decodedMapof attribute-value pairs.SecureAttrs.getSignedString(Map<String, String> attrs, String secret) Returns a String representing data in the attrs argument.static voidSecureAttrs.init(String name, String type, Properties properties) Initializes a SecureAttrs instance specified byname.static voidSecureAttrs.init(Properties properties) Creates two instances ofSecureAttrsnamed "symmetric" and "asymmetric" representing the two suppported crytp types.voidSecureAttrs.setPrivateKey(PrivateKey privatekey) This interface allows to set the private to be used for signing as an alternative to passing downSAE_CONFIG_PRIVATE_KEY_ALIASviainit.booleanVerifies 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
Classes in com.sun.identity.saml.common with annotations of type SupportedModifier and TypeClassDescriptionfinal classThis is a common class defining some constants common to all SAML elements.classThis class contains some utility methods for processing SAML protocols.Fields in com.sun.identity.saml.common with annotations of type SupportedModifier and TypeFieldDescriptionstatic final StringSAMLConstants.ACTION_NAMESPACEString used in theActionNamespaceattribute to refer to common sets of actions to perform on resources.static final StringSAMLConstants.ACTION_NAMESPACE_GHPPString used in theActionNamespaceattribute to refer to common sets of actions to perform on resources.static final StringSAMLConstants.ACTION_NAMESPACE_NEGATIONString used in theActionNamespaceattribute to refer to common sets of actions to perform on resources.static final StringSAMLConstants.ACTION_NAMESPACE_UNIXString used in theActionNamespaceattribute to refer to common sets of actions to perform on resources.static final StringSAMLConstants.ALGO_ID_C14N_EXCL_OMIT_COMMENTSExclusive XML canonicalization Algorithm URI.static final StringSAMLConstants.ALGO_ID_C14N_EXCL_WITH_COMMENTSExclusive XML canonicalization with comments Algorithm URI.static final StringSAMLConstants.ALGO_ID_C14N_OMIT_COMMENTSXML canonicalization Algorithm URI.static final StringSAMLConstants.ALGO_ID_C14N_WITH_COMMENTSXML canonicalization with comments Algorithm URI.static final StringSAMLConstants.ALGO_ID_MAC_HMAC_NOT_RECOMMENDED_MD5MAC Algorithm HMAC-MD5 URI.static final StringSAMLConstants.ALGO_ID_MAC_HMAC_RIPEMD160MAC Algorithm HMAC-RIPEMD160 URI.static final StringSAMLConstants.ALGO_ID_MAC_HMAC_SHA1MAC Algorithm HMAC-SHA1 URI - Required.static final StringSAMLConstants.ALGO_ID_MAC_HMAC_SHA256MAC Algorithm HMAC-SHA256 URI.static final StringSAMLConstants.ALGO_ID_MAC_HMAC_SHA384MAC Algorithm HMAC-SHA384 URI.static final StringSAMLConstants.ALGO_ID_MAC_HMAC_SHA512MAC Algorithm HMAC-SHA512 URI.static final StringSAMLConstants.ALGO_ID_SIGNATURE_DSASignature Algorithm DSAwithSHA1 URI - Required.static final StringSAMLConstants.ALGO_ID_SIGNATURE_DSA_256Signature Algorithm DSAwithSHA1 URI - Required.static final StringSAMLConstants.ALGO_ID_SIGNATURE_NOT_RECOMMENDED_RSA_MD5Signature Algorithm RSA-MD5 URI.static final StringSAMLConstants.ALGO_ID_SIGNATURE_RSASignature Algorithm RSAwithSHA1 URI - Recommended.static final StringSAMLConstants.ALGO_ID_SIGNATURE_RSA_RIPEMD160Signature Algorithm RSA-RIPEMD160 URI.static final StringSAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA1Signature Algorithm RSAwithSHA1 URI.static final StringSAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA256Signature Algorithm RSA-SHA256 URI.static final StringSAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA384Signature Algorithm RSA-SHA384 URI.static final StringSAMLConstants.ALGO_ID_SIGNATURE_RSA_SHA512Signature Algorithm RSA-SHA512 URI.static final StringSAMLConstants.assertionSAMLNameSpaceURISAML assertion namespace URI.static final StringSAMLConstants.CONFIRMATION_METHOD_BEARERSAML Bearer confirmation method identifier URI.static final StringSAMLConstants.CONFIRMATION_METHOD_HOLDEROFKEYSAML "Holder of Key" confirmation method identifier URI.static final StringSAMLConstants.NS_SECSOAP security namespace.static final StringSAMLConstants.NS_WSSESOAP utility namespace.static final StringSAMLConstants.NS_WSULiberty security namespace.static final StringSAMLConstants.NS_XMLNSXML schema namespace.static final StringSAMLConstants.SOAP_URISOAP 1.1 namespace URI.static final StringSAMLConstants.TRANSFORM_BASE64_DECODEBase64 decoding Transform URI.static final StringSAMLConstants.TRANSFORM_C14N_EXCL_OMIT_COMMENTSExclusive XML canonicalization Transform URI.static final StringSAMLConstants.TRANSFORM_C14N_EXCL_WITH_COMMENTSExclusive XML canonicalization with comments Transform URI.static final StringSAMLConstants.TRANSFORM_C14N_OMIT_COMMENTSXML canonicalization Transform URI.static final StringSAMLConstants.TRANSFORM_C14N_WITH_COMMENTSXML canonicalization with comments Transform URI.static final StringSAMLConstants.TRANSFORM_ENVELOPED_SIGNATUREEnveloped Signature Transform URI.static final StringSAMLConstants.TRANSFORM_XPATHXPath Transform URI.static final StringSAMLConstants.TRANSFORM_XPATH2FILTERXPath Filter v2.0 Transform URI.static final StringSAMLConstants.TRANSFORM_XPATH2FILTER04XPath Filter v2.0 Transform URI.static final StringSAMLConstants.TRANSFORM_XPATHFILTERCHGPXPath Filter v2.0 CHGP Transform URI.static final StringSAMLConstants.TRANSFORM_XPOINTERXPointer Transform URI.static final StringSAMLConstants.TRANSFORM_XSLTXSLT Transform URI.static final StringSAMLConstants.XMLSIG_NAMESPACE_URIXML Digital Signature namespace. -
Uses of Supported in com.sun.identity.saml2.common
Classes in com.sun.identity.saml2.common with annotations of type SupportedModifier and TypeClassDescriptionclassTheSAML2Utilscontains utility methods for SAML 2.0 implementation.Methods in com.sun.identity.saml2.common with annotations of type SupportedModifier and TypeMethodDescriptionstatic StringSAML2Utils.getReverseProxyUrl(String realm, String idpEntityId) Retrieves the reverse proxy URL configured for the specified IDP.static com.sun.identity.saml2.meta.SAML2MetaManagerSAML2Utils.getSAML2MetaManager()Returns an instance ofSAML2MetaManger.static com.sun.identity.saml2.meta.SAML2MetaManagerSAML2Utils.getSAML2MetaManagerWithToken(Object token) Returns an instance ofSAML2MetaManger. -
Uses of Supported in com.sun.identity.saml2.meta
Classes in com.sun.identity.saml2.meta with annotations of type SupportedModifier and TypeClassDescriptionfinal classTheSAML2MetaUtilsprovides metadata related util methods.Methods in com.sun.identity.saml2.meta with annotations of type SupportedModifier and TypeMethodDescriptionstatic StringSAML2MetaUtils.getMetaAliasByUri(String uri) Returns metaAlias embedded in uri.static StringSAML2MetaUtils.getRealmByMetaAlias(String metaAlias) Returns the realm by parsing the metaAlias. -
Uses of Supported in com.sun.identity.saml2.profile
Classes in com.sun.identity.saml2.profile with annotations of type SupportedModifier and TypeClassDescriptionclassThis class provides methods to send or processAssertionIDRequest.classThis class provides methods to send or processAttributeQuery.classThis class provides methods to send or processAuthnQuery.classThis class provides methods to send or processNameIDMappingRequest.classThis class is used by a service provider (SP) to process the response from an identity provider for the SP's Assertion Consumer Service.classThis class provides methods to send or processAttributeQuery.Methods in com.sun.identity.saml2.profile with annotations of type SupportedModifier 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 StringXACMLQueryUtil.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 NameIDMappingResponseNameIDMapping.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 MapSPACSUtils.processResponseForFedlet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, PrintWriter out) Processes response from Identity Provider to Fedlet (SP).static ResponseAssertionIDRequestUtil.sendAssertionIDRequest(AssertionIDRequest assertionIDRequest, String samlAuthorityEntityID, String role, String realm, String binding) Sends theAssertionIDRequestto specifiied Assertion ID Request Service and returnsResponsecoming from the Assertion ID Request Service.static AssertionAssertionIDRequestUtil.sendAssertionIDRequestURI(String assertionID, String samlAuthorityEntityID, String role, String realm) Sends the Assertion ID to specifiied Assertion ID Request Service and returnsAssertioncoming from the Assertion ID Request Service.static ResponseAttributeQueryUtil.sendAttributeQuery(AttributeQuery attrQuery, String attrAuthorityEntityID, String realm, String attrQueryProfile, String attrProfile, String binding) Sends theAttributeQueryto specified attribute authority and returnsResponsecoming from the attribute authority.static voidAttributeQueryUtil.sendAttributeQuery(AttributeQuery attrQuery, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String attrAuthorityEntityID, String realm, String attrQueryProfile, String attrProfile, String binding) Sends theAttributeQueryto specified attribute authority and returnsResponsecoming from the attribute authority.static ResponseAuthnQueryUtil.sendAuthnQuery(AuthnQuery authnQuery, String authnAuthorityEntityID, String realm, String binding) This method sends theAuthnQueryto specifiied authentication authority and returnsResponsecoming from the authentication authority. -
Uses of Supported in com.sun.identity.sm
Classes in com.sun.identity.sm with annotations of type SupportedModifier and TypeClassDescriptionclassThe classServiceConfigurationManagerprovides interfaces to manage the service's configuration data.classTheServiceManagerclass provides methods to register/remove services and to list currently registered services.classThe classServiceSchemaManagerprovides interfaces to manage the service's schema.classThe classSMSThreadPoolprovides interfaces to manage notification thread pools shared by idm and sm.Methods in com.sun.identity.sm with annotations of type SupportedModifier and TypeMethodDescriptionvoidServiceConfigManager.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.voidServiceManager.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.voidServiceConfigManager.deleteOrganizationConfig(String orgName) Deletes the organization configuration data for the given organization.booleanCompares this object with the given object.ServiceManager.getConfigManager(String serviceName, String version) Returns theServiceConfigManagerfor 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 theServiceSchemaManagerfor 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.voidServiceConfigManager.removeGlobalConfiguration(String groupName) Deletes the global configuration data for the given group name.voidServiceConfigManager.removeInstance(String instanceName) Removes the instance form the servicevoidServiceConfigManager.removeListener(String listenerID) Removes the listener from the service for the given listener ID.voidServiceSchemaManager.removeListener(String listenerID) Removes the listener from the service for the given listener ID.voidServiceConfigManager.removeOrganizationConfiguration(String orgName, String groupName) Deprecated.voidServiceConfigManager.removeOrganizationConfiguration(String orgName, String groupName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId) Deletes the organization's group configuration data.voidServiceManager.removeService(String serviceName, String version) Removes the service schema and configuration for the given service name.voidServiceSchemaManager.replaceSchema(InputStream xmlServiceSchema) Replaces the existing service schema with the given schema defined by the XML input stream that follows the SMS DTD.static voidSMSThreadPool.scheduleTask(Runnable task) Schedule a task forSMSThreadPoolto run.voidServiceSchemaManager.setI18NFileName(String url) Sets the I18N properties file name for the servicevoidServiceSchemaManager.setI18NJarURL(String url) Sets the URL of the JAR file that contains the I18N propertiesvoidServiceSchemaManager.setI18NKey(String i18nKey) Sets the i18nKey of the schema.voidServiceSchemaManager.setPropertiesViewBeanURL(String url) Sets the URL of the view bean for the service.voidServiceSchemaManager.setResourceName(String name) Sets the service's resource name for CREST representation.voidServiceSchemaManager.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.Constructors in com.sun.identity.sm with annotations of type SupportedModifierConstructorDescriptionServiceConfigManager(SSOToken token, String serviceName, String version) Creates an instance ofServiceConfigManagerfor 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 ofServiceSchemaManagerfor the given service and version pair. -
Uses of Supported in org.forgerock.oauth2.core
Classes in org.forgerock.oauth2.core with annotations of type SupportedModifier and TypeClassDescriptionenumIdentifies the OAuth2 Authorization Grant (aka OAuth2 Flow) undertaken to obtain an OAuth2 token.interfaceAn 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.Methods in org.forgerock.oauth2.core with annotations of type SupportedModifier 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.ClientOAuth2Request.getClient()Gets the client associated with this request, or null if not yet set.org.forgerock.oauth2.core.ClientRegistrationOAuth2Request.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> TOAuth2Request.getParameter(String name) Gets the specified parameter from the request.<T> TOAuth2Request.getParameter(String name, boolean checkQueryParam) Gets the specified parameter from the request.intOAuth2Request.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.voidOAuth2Request.setClient(org.forgerock.oauth2.core.Client client) Sets the client associated with this request.voidOAuth2Request.setClientRegistration(org.forgerock.oauth2.core.ClientRegistration clientRegistration) Set the OAuth2 client registration.voidOAuth2Request.setConsentResponseJwt(SignedJwt jwt) voidSets the user's session public reference for this request.voidOAuth2Request.setSession(String sessionId) Sets the user's session for this request.voidSets 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
Classes in org.forgerock.oauth2.core.plugins with annotations of type SupportedModifier and TypeInterfaceDescriptioninterfaceA plugin or (extension point) that allows modification of the OAuth2 access token before the token is persisted/returned to the client.interfaceA plugin or (extension point) that allows the OAuth2 provider to return additional data from an authorization request.interfaceA plugin or (extension point) that evaluates and returns an OAuth2 access token's scope information.interfaceA 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.interfaceA plugin or (extension point) that fetches the resource owners information based on an issued access token.Methods in org.forgerock.oauth2.core.plugins with annotations of type SupportedModifier 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.voidAccessTokenModifier.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
Classes in org.forgerock.openam.annotations.sm with annotations of type SupportedModifier and TypeClassDescription@interfaceIndicates 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
Classes in org.forgerock.openam.auth.nodes.script with annotations of type SupportedModifier and TypeClassDescriptionclassA wrapper class to support the generation of JWT assertions within scripts.classA wrapper class to support the validation of JWTs within scripts. -
Uses of Supported in org.forgerock.openam.ldap
Classes in org.forgerock.openam.ldap with annotations of type SupportedModifier and TypeClassDescriptionfinal classUtility methods to help interaction with the OpenDJ LDAP SDK.static classA model object that contains the settings used for cached connection pools.static classSimple failover Ldap Client.Fields in org.forgerock.openam.ldap with annotations of type SupportedModifier and TypeFieldDescriptionLDAPUtils.AFFINITY_ENABLEDAnOptionthat tells whether affinity based load balancing is enabled for the connections.static final Option<LDAPUtils.CachedPoolOptions>LDAPUtils.CACHED_POOL_OPTIONSAnOptionthat stores the settings related to cached connection pooling.Methods in org.forgerock.openam.ldap with annotations of type SupportedModifier and TypeMethodDescriptionstatic voidLDAPUtils.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 voidConverts 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 thecompareparameter.static Set<org.forgerock.openam.ldap.LDAPURL>LDAPUtils.convertToLDAPURLs(Set<String> servers) Converts the incoming set of URLs toLDAPURLinstances and returns them as a set.static ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.createFailoverConnectionFactory(String host, int defaultPort, boolean ssl, String authDN, String authPasswd, Options options) Creates a ConnectionFactory from the host string and associated details.static booleanDetermines if the DN's are equal.static StringLDAPUtils.escapeValue(String str) Escapes characters that should be escaped.static StringLDAPUtils.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 StringLDAPUtils.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 StringReturns the RDN without the attribute name from the passed inDnobject, for example:uid=demo,ou=people,dc=example,dc=comwill returndemo.static SearchScopeLDAPUtils.getSearchScope(String scope, SearchScope defaultScope) Converts string representation of scope (as defined in the configuration) to the correspondingSearchScopeobject.static booleanTests whether the supplied string is a DN, and is not the root DN.static DnCreates a DN from the specified DN string.static ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.newNamedConnectionFactory(ConnectionFactory factory, String name) Creates a new connection factory which forwards connection requests to the provided factory, but whosetoStringmethod will always returnname.static ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 ConnectionFactoryLDAPUtils.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 StringLDAPUtils.normalizeDN(String dn) Normalizes the DN.static FilterLDAPUtils.parseFilter(String filter, Filter defaultFilter) Parses the incoming filter, and in case of failure falls back to the default filter.static StringLDAPUtils.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 StringWhen provided an RDN, returns the attribute type name.static StringLDAPUtils.rdnTypeFromDn(String dn) When provided a DN, returns the attribute type name of the first RDN.static StringLDAPUtils.rdnTypeFromDn(Dn dn) When provided a DN, returns the attribute type name of the first RDN.static StringWhen provided an RDN, returns the value part.static StringLDAPUtils.rdnValueFromDn(String dn) When provided a DN, returns the value part of the first RDN.static StringLDAPUtils.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
Classes in org.forgerock.openam.scripting.api.identity with annotations of type SupportedModifier and TypeClassDescriptionclassA wrapper class to limit an authentication script's exposure to a AmIdentity objectclassA repository to retrieve user information within a scripting module's scriptMethods in org.forgerock.openam.scripting.api.identity with annotations of type SupportedModifier and TypeMethodDescriptionvoidScriptedIdentity.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 uservoidScriptedIdentity.setAttribute(String attributeName, String[] attributeValues) Sets the attribute's values. -
Uses of Supported in org.forgerock.openam.scripting.api.secrets
Classes in org.forgerock.openam.scripting.api.secrets with annotations of type SupportedModifier and TypeClassDescriptionclassA wrapper around the Secrets API that allows a simplified interface to access secrets from a scripting context.Methods in org.forgerock.openam.scripting.api.secrets with annotations of type SupportedModifier and TypeMethodDescriptionScriptedSecrets.getGenericSecret(String secretId) Allows the caller to access a generic type of secret from the Secrets API.Constructors in org.forgerock.openam.scripting.api.secrets with annotations of type SupportedModifierConstructorDescriptionScriptedSecrets(Secrets secrets, Realm realm) Constructor.ScriptedSecrets(Secrets secrets, Realm realm, Set<String> validPrefixes) Constructor. -
Uses of Supported in org.forgerock.openam.scripting.wrappers
Classes in org.forgerock.openam.scripting.wrappers with annotations of type SupportedModifier and TypeClassDescriptionclassAn Exception thrown by theHttpClientScriptWrapperwhich can be used for logging purposes in scripts.classA wrapper class to simplify sending HTTP requests in scripts.classA class providing an "openidm" object in JS scripts running within AM, which calls CRUDPAQ endpoints of the configured IDM instance.Methods in org.forgerock.openam.scripting.wrappers with annotations of type SupportedModifier 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
Classes in org.forgerock.openam.selfservice.config with annotations of type SupportedModifier and TypeInterfaceDescriptioninterfaceDefines the bases for which all self service console configuration should be built on. -
Uses of Supported in org.forgerock.openam.services.email
Classes in org.forgerock.openam.services.email with annotations of type SupportedModifier and TypeClassDescriptionclassDefaultMailServerimplementation that sends email via the configured SMTP server. -
Uses of Supported in org.forgerock.openam.services.email.rest
Classes in org.forgerock.openam.services.email.rest with annotations of type SupportedModifier and TypeClassDescriptionclassSends emails over REST using the OAuth2 client credentials grant type for authentication. -
Uses of Supported in org.forgerock.openam.sm
Classes in org.forgerock.openam.sm with annotations of type SupportedModifier and TypeInterfaceDescriptioninterfaceA registry for all service configuration that is defined in annotated service interfaces. -
Uses of Supported in org.forgerock.openam.sm.annotations
Classes in org.forgerock.openam.sm.annotations with annotations of type SupportedModifier and TypeClassDescriptionclassDescribes a service as defined by an annotated interface. -
Uses of Supported in org.forgerock.openam.upgrade
Classes in org.forgerock.openam.upgrade with annotations of type SupportedModifier and TypeClassDescriptionclassThis class contains utilities to upgrade the service schema configuration to be compatible with OpenAM.Methods in org.forgerock.openam.upgrade with annotations of type SupportedModifier and TypeMethodDescriptionstatic voidUpgradeUtils.addAttributeDefaultValues(String serviceName, String subSchemaName, String schemaType, String attributeName, Set defaultValues) Adds default values to an existing attribute.static voidUpgradeUtils.addAttributeToSchema(ServiceSchema serviceSchema, Node attributeSchemaNode) Adds new attribute schema to an existing service.static voidUpgradeUtils.addAttributeToSchema(String serviceName, String subSchemaName, String schemaType, Node attributeSchemaNode, SSOToken adminToken) Adds new attribute schema to an existing service.static voidUpgradeUtils.addAttributeToSubSchema(String serviceName, String subSchemaName, String schemaType, String attributeSchemaFile) Adds new attribute schema to a sub schema in an existing service.static voidUpgradeUtils.createService(String fileName) Creates a new service schema in the configuration store.static voidUpgradeUtils.removeAttributeSchema(ServiceSchema serviceSchema, String attributeName) Removes attribute schema from an existing service.static voidUpgradeUtils.removeAttributeSchema(String serviceName, String subSchemaName, String schemaType, String attributeName, SSOToken adminToken) Remove an attribute schema from an existing service.static voidUpgradeUtils.replaceAttributeSchema(ServiceSchema serviceSchema, String attributeName, Node attributeSchemaNode) Replace an attribute schema from an existing service with the new onestatic voidUpgradeUtils.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)