Skip navigation links

oracle.security.jps.service.login
Interface LoginService

All Superinterfaces:

JpsPersistable, ServiceInstance

public interface LoginService

extends ServiceInstance

This is a generic authentication service to invoke configured JAAS login modules.

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) This method will return the login context for all of the login modules configured in this context.
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 modules 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

getLoginContext

javax.security.auth.login.LoginContext getLoginContext(javax.security.auth.Subject subject,
                                                       javax.security.auth.callback.CallbackHandler cbh)
                                                       throws javax.security.auth.login.LoginException

This method will return the login context for all of the login modules configured in this context. If multiple login modules are configured as service instances in this context, the login moduleds are invoked exactly as listed in this context.

Parameters:

subject - the Subject to authenticate, or null.

cbh - the CallbackHandler object used by Login Modules to communicate with the user, or null.

Returns:

LoginContext instance that stacks all login modules in the same order in which they are listed in this context.

Throws:

javax.security.auth.login.LoginException

getLoginContext

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

This method will return the login context for the login modules associated with this context for the given login module names configured as service instance names in this context.

If multiple login modules are to be invoked together (i.e. modules contain more than one name), the login modules are invoked exactly as specified in the modules argument.

In other words, if the caller specifies [ "lmA", "lmB" ] in the modules argument, then "lmA" will be invoked prior to "lmB".

Note that if you set system property "jps.loginutil.invoke.order.dynamic" to "false", the login modules will be invoked in the order in which they are configured in this context.

If the subject is null then new subject will be created.

Parameters:

modules - The array of logn module names in this context to invoked as specified. If this argument is null or an empty array, this method will behave the same as getLoginContext(Subject subject, CallbackHandler cbh).

cbh - The callback handler to be used by this login module

subject - The subject used by this login module, if this is null then new subject will be returned

Returns:

LoginContext instance that encapsulates the supplied modules in the specified order

Throws:

javax.security.auth.login.LoginException - when an error condition occurred during method invocation

getContextName

java.lang.String getContextName()

This method returns the current jps context name in which this service is configured

Returns:

The jps context name

getAllAuthenticatedRoleProperties

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

Returns:

Map of configured authenticated role properties

getRemoveAnonymousRoleProperty

boolean getRemoveAnonymousRoleProperty()

This method returns the JpsConstants.REMOVE_ANONYMOUS_ROLE_PROPERTY property. If this property is not configured it returns JpsConstants.REMOVE_ANONYMOUS_ROLE_PROPERTY_DEFAULT

Returns:

remove anonymous role property value

getAuthenticatedRoleNameProperty

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

Returns:

authenticated role name property

getAuthenticatedRole

JpsAuthenticatedRole getAuthenticatedRole()
                                          throws JpsException

This method returns a JpsAuthenticatedRole based on the authenticated role property.

Returns:

JpsAuthenticatedRole

Throws:

JpsException

Skip navigation links