org.sandev.TaskHeap.UserLookup
Class UserLookupNode

java.lang.Object
  org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
      org.sandev.TaskHeap.UserLookup.UserLookupNodeBase
          org.sandev.TaskHeap.UserLookup.UserLookupNode

All Implemented Interfaces:

org.sandev.basics.util.AuthUserLookup, org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Loggable, org.sandev.basics.nodecommon.Messageable

public class UserLookupNode

extends UserLookupNodeBase

implements org.sandev.basics.util.AuthUserLookup

Implementation of UserLookupNode.

Field Summary

protected org.sandev.basics.util.AuthUser	internalComms Holds the internalComms user we looked up onStartup, if one was specified.
protected static long	INTERNALCOMMSID The uniqueID of the internal comms user as defined in the initial data.

Fields inherited from class org.sandev.TaskHeap.UserLookup.UserLookupNodeBase

ctrlwrappers, helperNodes, LOGDEBUG, LOGERROR, LOGFATAL, logger, LOGINFO, logLevel, LOGLEVEL_DEBUG, LOGLEVEL_ERROR, LOGLEVEL_FATAL, LOGLEVEL_INFO, LOGLEVEL_WARN, LOGWARN, messager, nodeInstance, outgoingSyncReaderQuery, outgoingSyncResourceQuery, parent, sandNodeErrorMessage, sandNodeState, SANDNODESTATE_FAILED, SANDNODESTATE_FAILING, SANDNODESTATE_RESUMING, SANDNODESTATE_RUNNING, SANDNODESTATE_STARTING, SANDNODESTATE_STOPPED, SANDNODESTATE_STOPPING, SANDNODESTATE_SUSPENDED, SANDNODESTATE_SUSPENDING, SANDNODESTATE_UNDEFINED, sandRoot

Fields inherited from class org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl

internalCommsPassword, internalCommsUsername

Fields inherited from interface org.sandev.basics.nodecommon.Controllable

OPERATION_FAIL, OPERATION_RESUME, OPERATION_SHUTDOWN, OPERATION_STARTUP, OPERATION_STR_FAIL, OPERATION_STR_RESUME, OPERATION_STR_SHUTDOWN, OPERATION_STR_STARTUP, OPERATION_STR_SUSPEND, OPERATION_STR_UNDEFINED, OPERATION_STRINGS, OPERATION_SUSPEND, OPERATION_UNDEFINED, SHUTDOWN_ERROR_RESTART_GLOBAL, SHUTDOWN_ERROR_RESTART_LOCAL, SHUTDOWN_ERROR_TERMINATE, SHUTDOWN_NORMAL, STATE_FAILED, STATE_FAILING, STATE_RESUMING, STATE_RUNNING, STATE_STARTING, STATE_STOPPED, STATE_STOPPING, STATE_STR_FAILED, STATE_STR_FAILING, STATE_STR_RESUMING, STATE_STR_RUNNING, STATE_STR_STARTING, STATE_STR_STOPPED, STATE_STR_STOPPING, STATE_STR_SUSPENDED, STATE_STR_SUSPENDING, STATE_STR_UNDEFINED, STATE_STRINGS, STATE_SUSPENDED, STATE_SUSPENDING, STATE_UNDEFINED

Constructor Summary

UserLookupNode()

Method Summary

java.lang.String	getDeploymentPrefix() Return the prefix for this deployment.
org.sandev.basics.util.AuthUser	getInternalComms() accessor for internalComms
org.sandev.basics.util.AuthUser	getUserForID(long authID) Return the AuthUser for the specified ID.
org.sandev.basics.util.AuthUser	getUserFromLogin(java.lang.String username, java.lang.String password) Lookup the AuthUser for authentication information given.
org.sandev.basics.util.AuthUser	lookupAuthUser(long authID, org.sandev.basics.structs.SandAttrVal[] matchInfo) First look this up as a Reader, then if that succeeds try looking this up as a Resource so the most authorized instance is cached.
protected void	noteAuthUserCacheAddition(java.lang.String source, org.sandev.basics.util.AuthUser au) Log the fact that we have added this AuthUser to our cache.
protected void	onStartup() When we startup, we load the internalComms user if a username was specified.
void	setInternalComms(org.sandev.basics.util.AuthUser user) mutator for internalComms

Methods inherited from class org.sandev.TaskHeap.UserLookup.UserLookupNodeBase

addWrapper, callReaderQuery, callResourceQuery, deliver, fieldHasFlag, getHelperNodes, getIDCache, getInternalCommsPassword, getInternalCommsPasswordDefaultValue, getInternalCommsPasswordFieldPrintValue, getInternalCommsPasswordFlag, getInternalCommsPasswordInvalidValue, getInternalCommsPasswordLengthMax, getInternalCommsPasswordLengthNorm, getInternalCommsPasswordMetatype, getInternalCommsPasswordPrintValue, getInternalCommsPasswordRange, getInternalCommsPasswordValidityCheck, getInternalCommsUsername, getInternalCommsUsernameDefaultValue, getInternalCommsUsernameFieldPrintValue, getInternalCommsUsernameFlag, getInternalCommsUsernameInvalidValue, getInternalCommsUsernameLengthMax, getInternalCommsUsernameLengthNorm, getInternalCommsUsernameMetatype, getInternalCommsUsernamePrintValue, getInternalCommsUsernameRange, getInternalCommsUsernameValidityCheck, getLogger, getLoggerDefaultValue, getLoggerFieldPrintValue, getLoggerFlag, getLoggerInvalidValue, getLoggerMetatype, getLoggerPrintValue, getLoggerRange, getLoggerValidityCheck, getLogLevel, getLogLevelActualVals, getLogLevelDefaultValue, getLogLevelEnumSummary, getLogLevelFieldPrintValue, getLogLevelFlag, getLogLevelInvalidValue, getLogLevelKeyVals, getLogLevelMetatype, getLogLevelPrintVals, getLogLevelPrintValue, getLogLevelRange, getLogLevelValidityCheck, getMessager, getMessagerDefaultValue, getMessagerFieldPrintValue, getMessagerFlag, getMessagerInvalidValue, getMessagerMetatype, getMessagerPrintValue, getMessagerRange, getMessagerValidityCheck, getNodeInstance, getNodeInstanceDefaultValue, getNodeInstanceFieldPrintValue, getNodeInstanceFlag, getNodeInstanceInvalidValue, getNodeInstanceMetatype, getNodeInstanceName, getNodeInstancePrintValue, getNodeInstanceRange, getNodeInstanceValidityCheck, getOutgoingSyncReaderQuery, getOutgoingSyncReaderQueryDefaultValue, getOutgoingSyncReaderQueryFieldPrintValue, getOutgoingSyncReaderQueryFlag, getOutgoingSyncReaderQueryInvalidValue, getOutgoingSyncReaderQueryMetatype, getOutgoingSyncReaderQueryPrintValue, getOutgoingSyncReaderQueryRange, getOutgoingSyncReaderQueryValidityCheck, getOutgoingSyncResourceQuery, getOutgoingSyncResourceQueryDefaultValue, getOutgoingSyncResourceQueryFieldPrintValue, getOutgoingSyncResourceQueryFlag, getOutgoingSyncResourceQueryInvalidValue, getOutgoingSyncResourceQueryMetatype, getOutgoingSyncResourceQueryPrintValue, getOutgoingSyncResourceQueryRange, getOutgoingSyncResourceQueryValidityCheck, getParent, getSandNodeErrorMessage, getSandNodeErrorMessageDefaultValue, getSandNodeErrorMessageFieldPrintValue, getSandNodeErrorMessageFlag, getSandNodeErrorMessageInvalidValue, getSandNodeErrorMessageLengthMax, getSandNodeErrorMessageLengthNorm, getSandNodeErrorMessageMetatype, getSandNodeErrorMessagePrintValue, getSandNodeErrorMessageRange, getSandNodeErrorMessageValidityCheck, getSandNodeState, getSandNodeStateActualVals, getSandNodeStateDefaultValue, getSandNodeStateEnumSummary, getSandNodeStateFieldPrintValue, getSandNodeStateFlag, getSandNodeStateInvalidValue, getSandNodeStateKeyVals, getSandNodeStateMetatype, getSandNodeStatePrintVals, getSandNodeStatePrintValue, getSandNodeStateRange, getSandNodeStateValidityCheck, getSandRoot, getServername, init, log, log, logLevelActual2Print, logLevelLabelToValue, logLevelPrint2Actual, logLevelPrint2Key, logLevelValueToLabel, notifyStateChange, onFailure, onRestart, onResume, onShutdown, onSuspend, receive, restart, resume, sandNodeStateActual2Print, sandNodeStateLabelToValue, sandNodeStatePrint2Actual, sandNodeStatePrint2Key, sandNodeStateValueToLabel, setHelperNodes, setInternalCommsPassword, setInternalCommsPassword, setInternalCommsUsername, setInternalCommsUsername, setLogger, setLogger, setLogLevel, setMessager, setMessager, setNodeInstance, setNodeInstance, setOutgoingSyncReaderQuery, setOutgoingSyncReaderQuery, setOutgoingSyncResourceQuery, setOutgoingSyncResourceQuery, setParent, setSandNodeErrorMessage, setSandNodeErrorMessage, setSandNodeState, setSandRoot, setupSecureReceive, setupSubscriptions, shutdown, startup, suspend, systemwideShutdown, validTransition

Methods inherited from class java.lang.Object

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

Field Detail

INTERNALCOMMSID

protected static final long INTERNALCOMMSID

The uniqueID of the internal comms user as defined in the initial data.

See Also:

Constant Field Values

internalComms

protected org.sandev.basics.util.AuthUser internalComms

Holds the internalComms user we looked up onStartup, if one was specified.

Constructor Detail

UserLookupNode

public UserLookupNode()

Method Detail

getInternalComms

public org.sandev.basics.util.AuthUser getInternalComms()

accessor for internalComms

setInternalComms

public void setInternalComms(org.sandev.basics.util.AuthUser user)

mutator for internalComms

getUserForID

public org.sandev.basics.util.AuthUser getUserForID(long authID)
                                             throws org.sandev.basics.structs.SandException

Return the AuthUser for the specified ID. Refer to the AuthUserLookup interface for details.

Specified by:

getUserForID in interface org.sandev.basics.util.AuthUserLookup

Throws:

org.sandev.basics.structs.SandException

getUserFromLogin

public org.sandev.basics.util.AuthUser getUserFromLogin(java.lang.String username,
                                                        java.lang.String password)
                                                 throws org.sandev.basics.structs.SandException

Lookup the AuthUser for authentication information given. Cache the result if found.

Specified by:

getUserFromLogin in interface org.sandev.basics.util.AuthUserLookup

Throws:

org.sandev.basics.structs.SandException

noteAuthUserCacheAddition

protected void noteAuthUserCacheAddition(java.lang.String source,
                                         org.sandev.basics.util.AuthUser au)

Log the fact that we have added this AuthUser to our cache. Factored for consistent description.

lookupAuthUser

public org.sandev.basics.util.AuthUser lookupAuthUser(long authID,
                                                      org.sandev.basics.structs.SandAttrVal[] matchInfo)
                                               throws org.sandev.basics.structs.SandException

First look this up as a Reader, then if that succeeds try looking this up as a Resource so the most authorized instance is cached. Return the message cast to an AuthUser.

Throws:

org.sandev.basics.structs.SandException

onStartup

protected void onStartup()
                  throws org.sandev.basics.structs.SandException

When we startup, we load the internalComms user if a username was specified. That way we have them cached for use in messaging.

Overrides:

onStartup in class UserLookupNodeBase

Throws:

org.sandev.basics.structs.SandException

getDeploymentPrefix

public java.lang.String getDeploymentPrefix()

Return the prefix for this deployment.