com.tibco.as.space.security

Class AuthenticationInfo

java.lang.Object

com.tibco.as.space.security.AuthenticationInfo

public class AuthenticationInfo
extends java.lang.Object

The authentication information, provided by the system, based on the configuration of the applicable security policy. The application must update the credential object, retrieved in getUserCredential(), in the authentication callback. See more details in AuthenticationCallback.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationInfo.Method The authentication method to be used.

Method Summary

Modifier and Type	Method and Description
AuthenticationInfo.Method	getAuthenticationMethod() Get the effective authentication method for the metaspace, which the application is joining.
java.lang.String	getHint() Get the authentication hint as configured for the security domain, to which the metaspace belongs.
java.lang.String	getMetaspaceName() Get the metaspace name, which the authenticating application is joining.
Credential	getUserCredential() Get the empty credential object, which must be updated based on the effective authentication type.

Methods inherited from class java.lang.Object

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

Method Detail

getAuthenticationMethod

public AuthenticationInfo.Method getAuthenticationMethod()

Get the effective authentication method for the metaspace, which the application is joining.

Returns:

The configured authentication method, which the security domain controller is configured to use.

getMetaspaceName

public java.lang.String getMetaspaceName()

Get the metaspace name, which the authenticating application is joining.

Returns:

The name of the metaspace.

getUserCredential

public Credential getUserCredential()

Get the empty credential object, which must be updated based on the effective authentication type.

Returns:

The credential to update. The credential object will be of the proper class, applicable to the authentication type. See UserPwdCredential and X509V3Credential for details.

getHint

public java.lang.String getHint()

Get the authentication hint as configured for the security domain, to which the metaspace belongs. This information can be used by system administrators to provide authenticating parties with more information on which credential to use (for the specified type) or which corporate authentication context (e.g. server or domain) to expect as the authentication source.

Returns:

The hint.