com.ibm.di.api
Class APIAuthenticator.Ret

java.lang.Object
  com.ibm.di.api.APIAuthenticator.Ret

Enclosing class:

APIAuthenticator

public static class APIAuthenticator.Ret
extends java.lang.Object

This class holds the status of the authentication. It is exposed as a script bean by the name "ret". Its public member variables "auth", "errordescr" and "errorcode" could be used in the script by the custom authentication process.

Field Summary

boolean	auth If this is set to true, it is considered that the provided by the user credentials are authentic.
java.lang.Object	errorcode A general purpose object which string representation will be returned with the thrown AuthenticationException.
java.lang.String	errordescr The description of the error which will be returned with the thrown AuthenticationException.

Constructor Summary

APIAuthenticator.Ret()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

auth

public boolean auth

If this is set to true, it is considered that the provided by the user credentials are authentic. If this is false then the authentication has failed.

errordescr

public java.lang.String errordescr

The description of the error which will be returned with the thrown AuthenticationException.

errorcode

public java.lang.Object errorcode

A general purpose object which string representation will be returned with the thrown AuthenticationException.

Constructor Detail

APIAuthenticator.Ret

public APIAuthenticator.Ret()