|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LoginService
This is a generic authentication service which encapsulates configured jaas login module into jps service model. This service defines a method to expose the login context of the configured login module for this service instance
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface oracle.security.jps.service.JpsPersistable |
---|
JpsPersistable.Mode |
Method Summary | |
---|---|
java.util.Map<java.lang.String,java.lang.String> |
getAllAuthenticatedRoleProperties() This method returns all properties configured for authenticated role Properties - JpsConstants.AUTHENTICATED_ROLE_NAME_PROPERTY - if not configured, then default value JpsConstants.AUTHENTICATED_ROLE_NAME_DEFAULT is returned JpsConstants.AUTHENTICATED_ROLE_UNIQUE_NAME_PROPERTY JpsConstants.AUTHENTICATED_ROLE_DISPLAY_NAME_PROPERTY JpsConstants.AUTHENTICATED_ROLE_DESCRIPTION_PROPERTY |
JpsAuthenticatedRole |
getAuthenticatedRole() This method returns a JpsAuthenticatedRole based on the authenticated role property. |
java.lang.String |
getAuthenticatedRoleNameProperty() This method returns the authenticated role name property JpsConstants.AUTHENTICATED_ROLE_NAME_PROPERTY If this property is not configured it returns JpsConstants.AUTHENTICATED_ROLE_NAME_PROPERTY_DEFAULT |
java.lang.String |
getContextName() This method returns the current jps context name in which this service is configured |
javax.security.auth.login.LoginContext |
getLoginContext(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler cbh) Instantiate a new LoginContext object for the configured login module instance with, a Subject to be authenticated, a CallbackHandler object |
javax.security.auth.login.LoginContext |
getLoginContext(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler cbh, java.lang.String[] modules) This method will return the login context for the login module associated with this context for the given login module names configured as service instance names in this context. |
boolean |
getRemoveAnonymousRoleProperty() This method returns the JpsConstants.REMOVE_ANONYMOUS_ROLE_PROPERTY property. |
Methods inherited from interface oracle.security.jps.service.ServiceInstance |
---|
accept, getName, getServiceProvider |
Methods inherited from interface oracle.security.jps.service.JpsPersistable |
---|
persist, refresh |
Method Detail |
---|
javax.security.auth.login.LoginContext getLoginContext(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler cbh) throws javax.security.auth.login.LoginException
LoginContext
object for the configured login module instance with, a Subject
to be authenticated, a CallbackHandler
objectsubject
- the Subject
to authenticate, or null
.cbh
- the CallbackHandler
object used by Login Modules to communicate with the user, or null
.LoginContext
for this instancejavax.security.auth.login.LoginException
javax.security.auth.login.LoginContext getLoginContext(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler cbh, java.lang.String[] modules) throws javax.security.auth.login.LoginException
If multiple login modules are to be invoked together (i.e. moduleNames contain more than one name), the login modules are invoked exactly as specified in the moduleNames argument.
In other words, if the caller specifies [ "lmA", "lmB" ] in the moduleNames argument, then "lmA" will be invoked prior to "lmB".
Note that the invocation order as implemented by this method differs from the default JDK behavior, which is based on static configuration.
If the subject is null then new subject will be created.
modules
- The array of logn module names in this context to invoked as specifiedcbh
- The callback handler to be used by this login modulesubject
- The subject used by this login module, if this is null then new subject will be returnedjavax.security.auth.login.LoginException
- when an error condition occurred during method invocationjava.lang.String getContextName()
java.util.Map<java.lang.String,java.lang.String> getAllAuthenticatedRoleProperties()
boolean getRemoveAnonymousRoleProperty()
java.lang.String getAuthenticatedRoleNameProperty()
JpsAuthenticatedRole getAuthenticatedRole() throws JpsException
JpsException
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |