oracle.security.jps.callback

Class IdentityCallback

java.lang.Object

oracle.security.jps.callback.IdentityCallback

All Implemented Interfaces:

javax.security.auth.callback.Callback, JpsCallback

public class IdentityCallback
extends java.lang.Object
implements JpsCallback

This class is used to pass the identity for authentication or assertion by Jps system. If this identity is already asserted and security is enabled then appropriate security policy must be provisioned becuase some of the methods of this class are security protected

Constructor Summary

Constructors

Constructor and Description
IdentityCallback()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthenticationType() Returns the authentication type
JpsCallbackType	getCallbackType() Returns the callback type
java.lang.String	getIdentity() Returns this identity name
java.lang.Object	getSession() This method can be used to pass any session session from Identity Asserter to Login module if needed
java.lang.String	getSessionCookie() Returns the session cookie
boolean	isIdentityAsserted() Returns if the identity is asserted or not
void	setAuthenticationType(java.lang.String authenticationType) This method sets the authentication type This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");.
void	setIdentity(java.lang.String identity) This method sets the identity name This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");.
void	setIdentityAsserted(boolean identityAsserted) This method sets the identityAsserted value, true or false This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");.
void	setSession(java.lang.Object object) This method can be used to pass any session session from Identity Asserter to Login module if needed
void	setSessionCookie(java.lang.String sessionCookie) This method sets the session cookie This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityCallback

public IdentityCallback()

Method Detail

setIdentity

public void setIdentity(java.lang.String identity)

This method sets the identity name

This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");. This may result in a SecurityException if security is enabled and security policy is not configured.

Parameters:

identity - The identity name

Throws:

java.lang.SecurityException - if JpsAuth.checkPermission does not allow access to this method.

getIdentity

public java.lang.String getIdentity()

Returns this identity name

Returns:

the identity

setAuthenticationType

public void setAuthenticationType(java.lang.String authenticationType)

This method sets the authentication type

This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");. This may result in a SecurityException if security is enabled and security policy is not configured.

Parameters:

authenticationType - The authentication type

Throws:

java.lang.SecurityException - if JpsAuth.checkPermission does not allow access to this method.

getAuthenticationType

public java.lang.String getAuthenticationType()

Returns the authentication type

Returns:

the authentication type

setIdentityAsserted

public void setIdentityAsserted(boolean identityAsserted)

This method sets the identityAsserted value, true or false

This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");. This may result in a SecurityException if security is enabled and security policy is not configured.

Parameters:

identityAsserted - The identityAsserted value. true or false

Throws:

java.lang.SecurityException - if JpsAuth.checkPermission does not allow access to this method.

isIdentityAsserted

public boolean isIdentityAsserted()

Returns if the identity is asserted or not

Returns:

true, if this identity is asserted, false otherwise

getSessionCookie

public java.lang.String getSessionCookie()

Returns the session cookie

Returns:

the session cookie

setSessionCookie

public void setSessionCookie(java.lang.String sessionCookie)

This method sets the session cookie

This method first calls <href>JpsAuth.checkPermission</href> and the permission is constructed as new JpsPermission("IdentityAssertion", "execute");. This may result in a SecurityException if security is enabled and security policy is not configured.

Parameters:

sessionCookie - The session cookie to be set

Throws:

java.lang.SecurityException - if JpsAuth.checkPermission does not allow access to this method.

getCallbackType

public JpsCallbackType getCallbackType()

Returns the callback type

Specified by:

getCallbackType in interface JpsCallback

Returns:

The JPS_IDENTITY_CALLBACK

setSession

public void setSession(java.lang.Object object)

This method can be used to pass any session session from Identity Asserter to Login module if needed

Parameters:

object -

getSession

public java.lang.Object getSession()

This method can be used to pass any session session from Identity Asserter to Login module if needed