org.idoox.security
Interface Credentials

All Superinterfaces:
java.security.Principal
All Known Subinterfaces:
ReceivedCredentials

public interface Credentials
extends java.security.Principal

Represents authentication information of an identity in the system (such as user, service, etc.)

Since:
3.0
Component:
Core

Field Summary
static int AUTH_STATUS_EXPIRED
           
static int AUTH_STATUS_INCOMPLETE
           
static int AUTH_STATUS_SUCCESS
          Values, which can be returned by getAuthenticationStatus method
 
Method Summary
 AssociationOptions getAcceptingOptionsRequired()
          Returns current required association options for the accepting connections using this Credentials object
 AssociationOptions getAcceptingOptionsSupported()
          Returns current supported association options for the accepting connections using this Credentials object
 int getAuthenticationStatus()
          Returns status of this instance
 AssociationOptions getInvocationOptionsRequired()
          Returns current required association options for the outgoing connections using this Credentials object
 AssociationOptions getInvocationOptionsSupported()
          Returns current supported association options for the outgoing connections using this Credentials object
 java.lang.String getProviderName()
          Returns name of the provider of this instance
 javax.security.auth.Subject getSubject()
          Returns JAAS's Subject which corresponds with these credentials
 void setAcceptingOptionsRequired(AssociationOptions value)
          Sets new required association options for the accepting connections using this Credentials object
 void setAcceptingOptionsSupported(AssociationOptions value)
          Sets new supported association options for the accepting connections using this Credentials object
 void setInvocationOptionsRequired(AssociationOptions value)
          Sets new required association options for the outgoing connections using this Credentials object
 void setInvocationOptionsSupported(AssociationOptions value)
          Sets new supported association options for the outgoing connections using this Credentials object
 
Methods inherited from interface java.security.Principal
equals, getName, hashCode, toString
 

Field Detail

AUTH_STATUS_SUCCESS

public static final int AUTH_STATUS_SUCCESS
Values, which can be returned by getAuthenticationStatus method

See Also:
Constant Field Values

AUTH_STATUS_EXPIRED

public static final int AUTH_STATUS_EXPIRED
See Also:
Constant Field Values

AUTH_STATUS_INCOMPLETE

public static final int AUTH_STATUS_INCOMPLETE
See Also:
Constant Field Values
Method Detail

getAuthenticationStatus

public int getAuthenticationStatus()
Returns status of this instance

Returns:
authentication status of this instance

getProviderName

public java.lang.String getProviderName()
Returns name of the provider of this instance

Returns:
name of the provider implementing this interface

getSubject

public javax.security.auth.Subject getSubject()
Returns JAAS's Subject which corresponds with these credentials

Returns:
Subject representing these credentials

getAcceptingOptionsSupported

public AssociationOptions getAcceptingOptionsSupported()
Returns current supported association options for the accepting connections using this Credentials object

Returns:
current accepting supported association options

setAcceptingOptionsSupported

public void setAcceptingOptionsSupported(AssociationOptions value)
Sets new supported association options for the accepting connections using this Credentials object

Parameters:
value - new association options to be set

getAcceptingOptionsRequired

public AssociationOptions getAcceptingOptionsRequired()
Returns current required association options for the accepting connections using this Credentials object

Returns:
current accepting required association options

setAcceptingOptionsRequired

public void setAcceptingOptionsRequired(AssociationOptions value)
Sets new required association options for the accepting connections using this Credentials object

Parameters:
value - new association options to be set

getInvocationOptionsSupported

public AssociationOptions getInvocationOptionsSupported()
Returns current supported association options for the outgoing connections using this Credentials object

Returns:
current invocation supported association options

setInvocationOptionsSupported

public void setInvocationOptionsSupported(AssociationOptions value)
Sets new supported association options for the outgoing connections using this Credentials object

Parameters:
value - new association options to be set

getInvocationOptionsRequired

public AssociationOptions getInvocationOptionsRequired()
Returns current required association options for the outgoing connections using this Credentials object

Returns:
current invocation required association options

setInvocationOptionsRequired

public void setInvocationOptionsRequired(AssociationOptions value)
Sets new required association options for the outgoing connections using this Credentials object

Parameters:
value - new association options to be set