Package org.wildfly.security.auth.callback

Class ExclusiveNameCallback

java.lang.Object

javax.security.auth.callback.NameCallback

org.wildfly.security.auth.callback.ExclusiveNameCallback

All Implemented Interfaces:

Serializable, Callback, ExtendedCallback

public class ExclusiveNameCallback
extends NameCallback
implements ExtendedCallback

A variation on NameCallback which allows exclusive access to the backing identity to be requested.

Author:

Farah Juma

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExclusiveNameCallback(String prompt, boolean needsExclusiveAccess, boolean optional)	Construct a new instance.
ExclusiveNameCallback(String prompt, String defaultName, boolean needsExclusiveAccess, boolean optional)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	hasExclusiveAccess()	Determine if exclusive access to the backing identity was granted.
boolean	isOptional()	Determine if this callback is optional.
boolean	needsExclusiveAccess()	Determine if exclusive access to the backing identity is required.
boolean	needsInformation()	Determine if this callback is requesting information.
void	setExclusiveAccess(boolean exclusiveAccess)	Set whether exclusive access to the backing identity was granted.

Methods inherited from class javax.security.auth.callback.NameCallback

getDefaultName, getName, getPrompt, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExclusiveNameCallback

public ExclusiveNameCallback(String prompt,
                             boolean needsExclusiveAccess,
                             boolean optional)

Construct a new instance.

Parameters:

prompt - the text prompt (must not be null)

needsExclusiveAccess - true if exclusive access to the backing identity is required

optional - true if the support for the callback is optional

ExclusiveNameCallback

public ExclusiveNameCallback(String prompt,
                             String defaultName,
                             boolean needsExclusiveAccess,
                             boolean optional)

Construct a new instance.

Parameters:

prompt - the text prompt (must not be null)

defaultName - the name to be used as the default name displayed with the prompt

needsExclusiveAccess - true if exclusive access to the backing identity is required

optional - true if the support for the callback is optional

Method Detail

needsExclusiveAccess

public boolean needsExclusiveAccess()

Determine if exclusive access to the backing identity is required.

Returns:

true if exclusive access to the backing identity is required, false otherwise

hasExclusiveAccess

public boolean hasExclusiveAccess()

Determine if exclusive access to the backing identity was granted.

Returns:

true if exclusive access to the backing identity was granted, false otherwise

setExclusiveAccess

public void setExclusiveAccess(boolean exclusiveAccess)

Set whether exclusive access to the backing identity was granted.

Parameters:

exclusiveAccess - true if exclusive access to the backing identity was granted, false otherwise

isOptional

public boolean isOptional()

Description copied from interface: ExtendedCallback

Determine if this callback is optional.

Specified by:

isOptional in interface ExtendedCallback

Returns:

true if the callback is optional, false if it is mandatory

needsInformation

public boolean needsInformation()

Description copied from interface: ExtendedCallback

Determine if this callback is requesting information.

Specified by:

needsInformation in interface ExtendedCallback

Returns:

true if the callback is requesting information, false if it is only providing information