com.novell.emframe.dev

Class AuthBrokerReport

java.lang.Object

com.novell.emframe.dev.AuthBrokerReport

public class AuthBrokerReport
extends java.lang.Object

This class can be used as a return from AuthBrokerAuthenticator login methods. It can contain an object to be used for the default loginApiObject but gives the ability for the user to also have additional information available if they request it. The AuthenticationBroker.getAPIReport() will return the Authenticator's created value or create one to be returned. This is only a place holder for a users data. It returns that data. No manipulation is done.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR Authentication failed with an error.
static int	INFORMATION Authentication needs more information.
static int	SUCCESS Authentication is successful.
static int	UNKNOWN Authentication success is unknown.
static int	WARNING Authentication succeeded or failed with a warning.

Constructor Summary

Constructors

Constructor and Description
AuthBrokerReport(int type, java.lang.String protocolId, java.lang.Object loginAPIObject, java.lang.Object userData, AuthBrokerException aeException) Creates an AuthBrokerReport.

Method Summary

Modifier and Type	Method and Description
AuthBrokerException	getException() Get any AuthBrokerException thrown.
java.lang.Object	getLoginAPIObject() Get the loginAPIObject from the AuthBrokerAuthentication object.
java.lang.String	getProtocolId() Get the id for the procotol, as defined in AuthenticationBroker.
int	getType() Get the authentication type.
java.lang.Object	getUserData() Get any additional data stored by the AuthBrokerAuthentication object.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

Authentication success is unknown.

See Also:

Constant Field Values

SUCCESS

public static final int SUCCESS

Authentication is successful.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Authentication failed with an error.

See Also:

Constant Field Values

WARNING

public static final int WARNING

Authentication succeeded or failed with a warning.

See Also:

Constant Field Values

INFORMATION

public static final int INFORMATION

Authentication needs more information.

See Also:

Constant Field Values

Constructor Detail

AuthBrokerReport

public AuthBrokerReport(int type,
                        java.lang.String protocolId,
                        java.lang.Object loginAPIObject,
                        java.lang.Object userData,
                        AuthBrokerException aeException)

Creates an AuthBrokerReport. Any of these values may be null.

Parameters:

type - - UNKNOWN or ERROR or WARNING or INFORMATION etc.

protocolId - - the id for the protocol, just a string identifier

loginAPIObject - - the loginAPIObject that is the useful thing.

userData - - additional placeholder for anything the user wants

aeException - - a valid AuthBrokerException

Method Detail

getType

public int getType()

Get the authentication type.

Returns:

int containing the authentication type

getProtocolId

public java.lang.String getProtocolId()

Get the id for the procotol, as defined in AuthenticationBroker.

Returns:

String containing the protocol id.

getLoginAPIObject

public java.lang.Object getLoginAPIObject()

Get the loginAPIObject from the AuthBrokerAuthentication object.

Returns:

Object returned from the AuthBrokerAuthentication.login() method

getUserData

public java.lang.Object getUserData()

Get any additional data stored by the AuthBrokerAuthentication object.

Returns:

Object containing additional data

getException

public AuthBrokerException getException()

Get any AuthBrokerException thrown.

Returns:

AuthBrokerException thrown during login