Class AppConfigurationEntry
java.lang.Object
javax.security.auth.login.AppConfigurationEntry
This class represents a single
LoginModule
entry
configured for the application specified in the
getAppConfigurationEntry(String appName)
method in the Configuration
class. Each respective
AppConfigurationEntry
contains a LoginModule
name,
a control flag (specifying whether this LoginModule
is
REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL), and LoginModule-specific
options. Please refer to the Configuration
class for
more information on the different control flags and their semantics.- Since:
- 1.4
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This class represents whether aLoginModule
is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. -
Constructor Summary
ConstructorsConstructorDescriptionAppConfigurationEntry
(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String, ?> options) Default constructor for this class. -
Method Summary
Modifier and TypeMethodDescriptionReturn the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for thisLoginModule
.Get the class name of the configuredLoginModule
.Get the options configured for thisLoginModule
.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
AppConfigurationEntry
public AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String, ?> options) Default constructor for this class.This entry represents a single
LoginModule
entry configured for the application specified in thegetAppConfigurationEntry(String appName)
method from theConfiguration
class.- Parameters:
loginModuleName
- String representing the class name of theLoginModule
configured for the specified application.controlFlag
- either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.options
- the options configured for thisLoginModule
.- Throws:
IllegalArgumentException
- ifloginModuleName
is null, ifLoginModuleName
has a length of 0, ifcontrolFlag
is not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or ifoptions
is null.
-
-
Method Details
-
getLoginModuleName
Get the class name of the configuredLoginModule
.- Returns:
- the class name of the configured
LoginModule
as a String.
-
getControlFlag
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for thisLoginModule
.- Returns:
- the controlFlag
(either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL)
for this
LoginModule
.
-
getOptions
-