com.tsgrp.opencontent.core.authentication.model

Class AuthenticationResult

java.lang.Object

com.tsgrp.opencontent.core.authentication.model.AuthenticationResult

All Implemented Interfaces:

OpenContentResultLegacy

public class AuthenticationResult
extends java.lang.Object
implements OpenContentResultLegacy

Returned by IAuthentication methods, A simple POJO class to store the return values of authentication. It contains a ticket if authentication was successful, and errors and/or exceptions containing the reason authentication failed.

Member Variable	Description
Boolean valid	Equals true authentication was successful, otherwise false.
String ticket	Ticket associated with a successful authentication attempt.
String error	Error message associated with the authentication attempt if authentication failed.
String exception	Exception associated with the authentication attempt if authentication failed.

Constructor Summary

Constructors

Constructor and Description
AuthenticationResult()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError() Get the error message associated with the authentication attempt if authentication failed.
java.lang.String	getException() Get the exception associated with the authentication attempt if authentication failed.
java.lang.String	getTicket() Get the ticket associated with a successful authentication attempt.
boolean	isValid() Determine whether authentication was successful.
void	setError(java.lang.String error)
void	setException(java.lang.String exception)
void	setTicket(java.lang.String ticket)
void	setValid(boolean valid)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationResult

public AuthenticationResult()

Method Detail

getException

public java.lang.String getException()

Get the exception associated with the authentication attempt if authentication failed.

Returns:

the exception causing authentication failure.

setException

public void setException(java.lang.String exception)

Specified by:

setException in interface OpenContentResultLegacy

getError

public java.lang.String getError()

Get the error message associated with the authentication attempt if authentication failed.

Returns:

the error message explaining authentication failure.

setError

public void setError(java.lang.String error)

Specified by:

setError in interface OpenContentResultLegacy

getTicket

public java.lang.String getTicket()

Get the ticket associated with a successful authentication attempt. This ticket can be used to perform operations with other services.

Returns:

a valid ticket resulting from successful authentication.

setTicket

public void setTicket(java.lang.String ticket)

isValid

public boolean isValid()

Determine whether authentication was successful. If it was successful, the getTicket() method will return a non-null value. If authentication was unsuccessful, either getException() or getError() should return non-null.

Returns:

whether authentication was successful.

setValid

public void setValid(boolean valid)

Specified by:

setValid in interface OpenContentResultLegacy