|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.sandev.basics.Authorizer.AuthorizerNodeDecl
org.sandev.basics.Authorizer.AuthorizerNodeBase
public class AuthorizerNodeBase
AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.Authorizer.AuthorizerNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Jul 31, 2008 4:34:14 PM
This file contains:
| Field Summary | |
|---|---|
protected ControlWrapper[] |
ctrlwrappers
The control wrappers we need to notify of state or parameter changes. |
protected Controllable[] |
helperNodes
Our helper nodes |
protected IDLookup |
idLookup
The instance we use for looking up data references. |
protected static int |
LOGDEBUG
Convenience redeclaration of corresponding Logger.LOGLEVEL constant |
protected static int |
LOGERROR
Convenience redeclaration of corresponding Logger.LOGLEVEL constant |
protected static int |
LOGFATAL
Convenience redeclaration of corresponding Logger.LOGLEVEL constant |
protected Logger |
logger
Logfile output at specified severity levels. |
protected static int |
LOGINFO
Convenience redeclaration of corresponding Logger.LOGLEVEL constant |
protected int |
logLevel
Calls to log with severity levels less than this value will be ignored. |
static int |
LOGLEVEL_DEBUG
Possible value for logLevel |
static int |
LOGLEVEL_ERROR
Possible value for logLevel |
static int |
LOGLEVEL_FATAL
Possible value for logLevel |
static int |
LOGLEVEL_INFO
Possible value for logLevel |
static int |
LOGLEVEL_WARN
Possible value for logLevel |
protected static int |
LOGWARN
Convenience redeclaration of corresponding Logger.LOGLEVEL constant |
protected Messager |
messager
Communications to and from this node. |
protected NodeInstance |
nodeInstance
The declaration used to initialize this node instance when it was first created. |
protected Controllable |
parent
Our parent node |
protected java.lang.String |
sandNodeErrorMessage
Text details of the node execution error. |
protected int |
sandNodeState
Runtime state of the node. |
static int |
SANDNODESTATE_FAILED
Possible value for sandNodeState |
static int |
SANDNODESTATE_FAILING
Possible value for sandNodeState |
static int |
SANDNODESTATE_RESUMING
Possible value for sandNodeState |
static int |
SANDNODESTATE_RUNNING
Possible value for sandNodeState |
static int |
SANDNODESTATE_STARTING
Possible value for sandNodeState |
static int |
SANDNODESTATE_STOPPED
Possible value for sandNodeState |
static int |
SANDNODESTATE_STOPPING
Possible value for sandNodeState |
static int |
SANDNODESTATE_SUSPENDED
Possible value for sandNodeState |
static int |
SANDNODESTATE_SUSPENDING
Possible value for sandNodeState |
static int |
SANDNODESTATE_UNDEFINED
Possible value for sandNodeState |
protected SandRoot |
sandRoot
Back reference to the SandRoot that launched us. |
protected AuthUserLookup |
userLookup
The instance we use for looking up users. |
| Fields inherited from class org.sandev.basics.Authorizer.AuthorizerNodeDecl |
|---|
authFilterClassName, encryptorName, peerAuthUserLookupNode, peerIDLookupNode, serializerClassName |
| Constructor Summary | |
|---|---|
AuthorizerNodeBase()
Default constructor calls init. |
|
| Method Summary | |
|---|---|
void |
addWrapper(ControlWrapper wrapper)
Add the specified wrapper to our notification collection |
SandCollectionMessage |
callQuery(SandQueryMessage sqm)
Generalized query method to handle all queries understood by this node |
void |
deliver(SandMessage msg)
Only those deliver methods explicitely declared by the node should actually be called. |
boolean |
fieldHasFlag(java.lang.String fieldname,
int fieldflag)
Return true if the named field declares the indicated flag, false otherwise. |
java.lang.String |
getAuthFilterClassName()
Accessor for authFilterClassName |
static java.lang.String |
getAuthFilterClassNameDefaultValue()
Default value for authFilterClassName. |
java.lang.String |
getAuthFilterClassNameFieldPrintValue()
Return the print name of the authFilterClassName field. |
static boolean |
getAuthFilterClassNameFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getAuthFilterClassNameInvalidValue()
Invalid value for authFilterClassName. |
static int |
getAuthFilterClassNameLengthMax()
Maximum authFilterClassName length is 120 characters |
static int |
getAuthFilterClassNameLengthNorm()
Normal authFilterClassName length is 60 characters |
java.lang.String |
getAuthFilterClassNameMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getAuthFilterClassNamePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getAuthFilterClassNameRange()
Return the range specification for this field |
java.lang.String |
getAuthFilterClassNameValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getDeploymentPrefix()
Return the prefix for this deployment. |
java.lang.String |
getEncryptorName()
Accessor for encryptorName |
static java.lang.String |
getEncryptorNameDefaultValue()
Default value for encryptorName. |
java.lang.String |
getEncryptorNameFieldPrintValue()
Return the print name of the encryptorName field. |
static boolean |
getEncryptorNameFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getEncryptorNameInvalidValue()
Invalid value for encryptorName. |
static int |
getEncryptorNameLengthMax()
Maximum encryptorName length is 120 characters |
static int |
getEncryptorNameLengthNorm()
Normal encryptorName length is 60 characters |
java.lang.String |
getEncryptorNameMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getEncryptorNamePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getEncryptorNameRange()
Return the range specification for this field |
java.lang.String |
getEncryptorNameValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Controllable[] |
getHelperNodes()
accessor for helperNodes |
IDCache |
getIDCache()
Retrieve an IDCache for use by this node. |
IDLookup |
getIDLookup()
initializing accessor for idLookup. |
SandPersistMessage |
getInstance(java.lang.String classname,
long id,
AuthUser user)
Convenience passthrough call to our configured IDLookup. |
Logger |
getLogger()
Accessor for logger |
static Logger |
getLoggerDefaultValue()
Default value for logger. |
java.lang.String |
getLoggerFieldPrintValue()
Return the print name of the logger field. |
static boolean |
getLoggerFlag(int fieldflag)
Field flag accessor. |
static Logger |
getLoggerInvalidValue()
Invalid value for logger. |
java.lang.String |
getLoggerMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getLoggerPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getLoggerRange()
Return the range specification for this field |
java.lang.String |
getLoggerValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
int |
getLogLevel()
Accessor for logLevel |
static java.lang.String[] |
getLogLevelActualVals()
Return an array of the possible values for this field as Strings. |
static int |
getLogLevelDefaultValue()
Default value for logLevel. |
static java.lang.String |
getLogLevelEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes. |
java.lang.String |
getLogLevelFieldPrintValue()
Return the print name of the logLevel field. |
static boolean |
getLogLevelFlag(int fieldflag)
Field flag accessor. |
static int |
getLogLevelInvalidValue()
Invalid value for logLevel. |
static java.lang.String[] |
getLogLevelKeyVals()
Return an array of unique keys for the values of this field. |
java.lang.String |
getLogLevelMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
static java.lang.String[] |
getLogLevelPrintVals()
Return an array of the possible values for this field in display format. |
java.lang.String |
getLogLevelPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getLogLevelRange()
Return the range specification for this field |
java.lang.String |
getLogLevelValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Messager |
getMessager()
Accessor for messager |
static Messager |
getMessagerDefaultValue()
Default value for messager. |
java.lang.String |
getMessagerFieldPrintValue()
Return the print name of the messager field. |
static boolean |
getMessagerFlag(int fieldflag)
Field flag accessor. |
static Messager |
getMessagerInvalidValue()
Invalid value for messager. |
java.lang.String |
getMessagerMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getMessagerPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getMessagerRange()
Return the range specification for this field |
java.lang.String |
getMessagerValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
NodeInstance |
getNodeInstance()
Accessor for nodeInstance |
static NodeInstance |
getNodeInstanceDefaultValue()
Default value for nodeInstance. |
java.lang.String |
getNodeInstanceFieldPrintValue()
Return the print name of the nodeInstance field. |
static boolean |
getNodeInstanceFlag(int fieldflag)
Field flag accessor. |
static NodeInstance |
getNodeInstanceInvalidValue()
Invalid value for nodeInstance. |
java.lang.String |
getNodeInstanceMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getNodeInstanceName()
convenience wrapper method to retrieve our instance name |
java.lang.String |
getNodeInstancePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getNodeInstanceRange()
Return the range specification for this field |
java.lang.String |
getNodeInstanceValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Controllable |
getParent()
accessor for parent |
java.lang.String |
getPeerAuthUserLookupNode()
Accessor for peerAuthUserLookupNode |
static java.lang.String |
getPeerAuthUserLookupNodeDefaultValue()
Default value for peerAuthUserLookupNode. |
java.lang.String |
getPeerAuthUserLookupNodeFieldPrintValue()
Return the print name of the peerAuthUserLookupNode field. |
static boolean |
getPeerAuthUserLookupNodeFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getPeerAuthUserLookupNodeInvalidValue()
Invalid value for peerAuthUserLookupNode. |
static int |
getPeerAuthUserLookupNodeLengthMax()
Maximum peerAuthUserLookupNode length is 60 characters |
static int |
getPeerAuthUserLookupNodeLengthNorm()
Normal peerAuthUserLookupNode length is 30 characters |
java.lang.String |
getPeerAuthUserLookupNodeMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getPeerAuthUserLookupNodePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getPeerAuthUserLookupNodeRange()
Return the range specification for this field |
java.lang.String |
getPeerAuthUserLookupNodeValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getPeerIDLookupNode()
Accessor for peerIDLookupNode |
static java.lang.String |
getPeerIDLookupNodeDefaultValue()
Default value for peerIDLookupNode. |
java.lang.String |
getPeerIDLookupNodeFieldPrintValue()
Return the print name of the peerIDLookupNode field. |
static boolean |
getPeerIDLookupNodeFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getPeerIDLookupNodeInvalidValue()
Invalid value for peerIDLookupNode. |
static int |
getPeerIDLookupNodeLengthMax()
Maximum peerIDLookupNode length is 60 characters |
static int |
getPeerIDLookupNodeLengthNorm()
Normal peerIDLookupNode length is 30 characters |
java.lang.String |
getPeerIDLookupNodeMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getPeerIDLookupNodePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getPeerIDLookupNodeRange()
Return the range specification for this field |
java.lang.String |
getPeerIDLookupNodeValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getSandNodeErrorMessage()
Accessor for sandNodeErrorMessage |
static java.lang.String |
getSandNodeErrorMessageDefaultValue()
Default value for sandNodeErrorMessage. |
java.lang.String |
getSandNodeErrorMessageFieldPrintValue()
Return the print name of the sandNodeErrorMessage field. |
static boolean |
getSandNodeErrorMessageFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getSandNodeErrorMessageInvalidValue()
Invalid value for sandNodeErrorMessage. |
static int |
getSandNodeErrorMessageLengthMax()
Maximum sandNodeErrorMessage length is 70 characters |
static int |
getSandNodeErrorMessageLengthNorm()
Normal sandNodeErrorMessage length is 30 characters |
java.lang.String |
getSandNodeErrorMessageMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandNodeErrorMessagePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandNodeErrorMessageRange()
Return the range specification for this field |
java.lang.String |
getSandNodeErrorMessageValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
int |
getSandNodeState()
Accessor for sandNodeState |
static java.lang.String[] |
getSandNodeStateActualVals()
Return an array of the possible values for this field as Strings. |
static int |
getSandNodeStateDefaultValue()
Default value for sandNodeState. |
static java.lang.String |
getSandNodeStateEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes. |
java.lang.String |
getSandNodeStateFieldPrintValue()
Return the print name of the sandNodeState field. |
static boolean |
getSandNodeStateFlag(int fieldflag)
Field flag accessor. |
static int |
getSandNodeStateInvalidValue()
Invalid value for sandNodeState. |
static java.lang.String[] |
getSandNodeStateKeyVals()
Return an array of unique keys for the values of this field. |
java.lang.String |
getSandNodeStateMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
static java.lang.String[] |
getSandNodeStatePrintVals()
Return an array of the possible values for this field in display format. |
java.lang.String |
getSandNodeStatePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandNodeStateRange()
Return the range specification for this field |
java.lang.String |
getSandNodeStateValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
SandRoot |
getSandRoot()
accessor for sandRoot |
java.lang.String |
getSerializerClassName()
Accessor for serializerClassName |
static java.lang.String |
getSerializerClassNameDefaultValue()
Default value for serializerClassName. |
java.lang.String |
getSerializerClassNameFieldPrintValue()
Return the print name of the serializerClassName field. |
static boolean |
getSerializerClassNameFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getSerializerClassNameInvalidValue()
Invalid value for serializerClassName. |
static int |
getSerializerClassNameLengthMax()
Maximum serializerClassName length is 120 characters |
static int |
getSerializerClassNameLengthNorm()
Normal serializerClassName length is 60 characters |
java.lang.String |
getSerializerClassNameMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSerializerClassNamePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSerializerClassNameRange()
Return the range specification for this field |
java.lang.String |
getSerializerClassNameValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getServername()
convenience wrapper method to retrieve our home server name |
AuthUser |
getUserForID(long authID)
Calls through to our AuthUserLookup |
AuthUser |
getUserFromLogin(java.lang.String username,
java.lang.String password)
Calls through to our AuthUserLookup |
AuthUserLookup |
getUserLookup()
initializing accessor for userLookup. |
void |
init()
Initialize all fields to their default values |
void |
log(int severity,
java.lang.String msg)
Log the message with the specified severity. |
void |
log(java.lang.String msg)
Shorthand for log(Logger.LOGLEVEL_INFO,msg) |
static java.lang.String |
logLevelActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. |
int |
logLevelLabelToValue(java.lang.String label)
Given a label, return the value for it. |
static int |
logLevelLabelToValueStatic(java.lang.String label)
|
static java.lang.String |
logLevelPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. |
static java.lang.String |
logLevelPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. |
java.lang.String |
logLevelValueToLabel(int val)
Given a value, return the declared label for it. |
static java.lang.String |
logLevelValueToLabelStatic(int val)
|
protected void |
notifyStateChange(int prevState,
int currState)
Notify our registered control wrappers of our state change |
protected void |
onFailure()
Override this method to do work when the node enters the failed state. |
protected void |
onRestart()
Override this method to do work during startup(). |
protected void |
onResume()
Override this method to do work during resume(). |
protected void |
onShutdown()
Override this method to do work during shutdown(). |
protected void |
onStartup()
Override this method to do work during startup(). |
protected void |
onSuspend()
Override this method to do work during suspend(). |
void |
readConfigParamsFromNodeInstance(NodeInstance ni)
Read our configuration parameter values from the our node instance. |
SandMessage |
receive(SandMessage msg)
Only those receive methods explicitely declared by the node should actually be called. |
void |
restart()
Restarts a running node by calling shutdown and then startup |
void |
resume()
Resumes a suspended node. |
static java.lang.String |
sandNodeStateActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. |
int |
sandNodeStateLabelToValue(java.lang.String label)
Given a label, return the value for it. |
static int |
sandNodeStateLabelToValueStatic(java.lang.String label)
|
static java.lang.String |
sandNodeStatePrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. |
static java.lang.String |
sandNodeStatePrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. |
java.lang.String |
sandNodeStateValueToLabel(int val)
Given a value, return the declared label for it. |
static java.lang.String |
sandNodeStateValueToLabelStatic(int val)
|
void |
setAuthFilterClassName(java.lang.Object authFilterClassName)
Generic mutator for authFilterClassName |
void |
setAuthFilterClassName(java.lang.String authFilterClassName)
Mutator for authFilterClassName |
void |
setEncryptorName(java.lang.Object encryptorName)
Generic mutator for encryptorName |
void |
setEncryptorName(java.lang.String encryptorName)
Mutator for encryptorName |
void |
setHelperNodes(Controllable[] nodes)
mutator for helperNodes |
void |
setIDLookup(IDLookup val)
mutator for idLookup |
void |
setLogger(Logger logger)
Mutator for logger |
void |
setLogger(java.lang.Object logger)
Generic mutator for logger |
void |
setLogLevel(int logLevel)
Mutator for logLevel |
void |
setMessager(Messager messager)
Mutator for messager |
void |
setMessager(java.lang.Object messager)
Generic mutator for messager |
void |
setNodeInstance(NodeInstance nodeInstance)
Mutator for nodeInstance |
void |
setNodeInstance(java.lang.Object nodeInstance)
Generic mutator for nodeInstance |
void |
setParent(Controllable node)
mutator for parent |
void |
setPeerAuthUserLookupNode(java.lang.Object peerAuthUserLookupNode)
Generic mutator for peerAuthUserLookupNode |
void |
setPeerAuthUserLookupNode(java.lang.String peerAuthUserLookupNode)
Mutator for peerAuthUserLookupNode |
void |
setPeerIDLookupNode(java.lang.Object peerIDLookupNode)
Generic mutator for peerIDLookupNode |
void |
setPeerIDLookupNode(java.lang.String peerIDLookupNode)
Mutator for peerIDLookupNode |
void |
setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)
Generic mutator for sandNodeErrorMessage |
void |
setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)
Mutator for sandNodeErrorMessage |
void |
setSandNodeState(int sandNodeState)
Mutator for sandNodeState |
void |
setSandRoot(SandRoot val)
mutator for sandRoot |
void |
setSerializerClassName(java.lang.Object serializerClassName)
Generic mutator for serializerClassName |
void |
setSerializerClassName(java.lang.String serializerClassName)
Mutator for serializerClassName |
protected void |
setupSecureReceive()
Register us for receive with our local Authorizer |
protected void |
setupSubscriptions()
Subscribe us to the nodes we need to listen to |
void |
setUserLookup(AuthUserLookup val)
mutator for userLookup |
void |
shutdown()
Stops a running node. |
void |
startup()
Starts a stopped node. |
void |
suspend()
Suspends a running node. |
void |
systemwideShutdown(int code)
Call our shutdown, which shuts down our local nodes, then cascade this call upward to our parent so it spreads throughout the system as needed. |
boolean |
validTransition(int transition)
Validates a state transition by comparing the desired transition with the current state. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected int sandNodeState
Controllable
public static final int SANDNODESTATE_UNDEFINED
public static final int SANDNODESTATE_RUNNING
public static final int SANDNODESTATE_SUSPENDED
public static final int SANDNODESTATE_STOPPED
public static final int SANDNODESTATE_FAILED
public static final int SANDNODESTATE_STARTING
public static final int SANDNODESTATE_STOPPING
public static final int SANDNODESTATE_SUSPENDING
public static final int SANDNODESTATE_RESUMING
public static final int SANDNODESTATE_FAILING
protected java.lang.String sandNodeErrorMessage
protected Messager messager
protected Logger logger
protected int logLevel
public static final int LOGLEVEL_DEBUG
public static final int LOGLEVEL_INFO
public static final int LOGLEVEL_WARN
public static final int LOGLEVEL_ERROR
public static final int LOGLEVEL_FATAL
protected NodeInstance nodeInstance
protected SandRoot sandRoot
protected static final int LOGDEBUG
protected static final int LOGINFO
protected static final int LOGWARN
protected static final int LOGERROR
protected static final int LOGFATAL
protected Controllable parent
protected Controllable[] helperNodes
protected ControlWrapper[] ctrlwrappers
protected AuthUserLookup userLookup
protected IDLookup idLookup
| Constructor Detail |
|---|
public AuthorizerNodeBase()
| Method Detail |
|---|
public boolean fieldHasFlag(java.lang.String&nbs