org.sandev.basics.structs
Class IODeclBaseStruct

java.lang.Object
  org.sandev.basics.structs.IODeclBaseStruct

Direct Known Subclasses:

IODeclBase, IODeclCallStruct, IODeclReceiveStruct, IODeclSendStruct, IODeclSubscribeStruct

public class IODeclBaseStruct
extends java.lang.Object

A base struct for IO declarations. IO declarations are saved as part of a NodeInstance and are not persistent or transmittable. There are no query, update or collection forms.

summary fields: mode optimize
help text: A base struct for IO declarations.

Field Summary

protected java.lang.String	gateway The instance name of our local authorizer used as our gateway.
protected int	mode Communications between trusted nodes may be done directly, without authorization or encryption.
protected int	optimize Optimization, typically through direct method invocation, is done by default whenever possible.

Constructor Summary

IODeclBaseStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

mode

protected int mode

Communications between trusted nodes may be done directly, without authorization or encryption. This is appropriate between trusted nodes running on the same server where there are no security issues. The alternative is secure communications. Secure communications must be used when communicating across servers.

enumerated constant values:

• INVALID("please specify a value") = 0
  
• DIRECT("direct - same server, trusted") = 1
  
• SECURE("secure - use authorizer") = 2
  

declared invalid value: 0
help text: Whether communications will be directly between two trusted nodes on the same server without authorization, or securely across different servers.

optimize

protected int optimize

Optimization, typically through direct method invocation, is done by default whenever possible. However there are times where this optimization should be disabled (such as tracking all messages through a message server for debugging purposes, or whatever) so this field provides for turning off optimization.

declared default value: IF_POSSIBLE

enumerated constant values:

• IF_POSSIBLE("if possible") = 0
  
• NEVER("never") = 1
  

declared invalid value: -1
help text: Whether optimized communications should be used when possible or explicitely turned off.

gateway

protected java.lang.String gateway

The instance name of our local authorizer used as our gateway. If using direct communication, this field is ignored and should be left blank for clarity.

Length in characters, normal: 10 max: 80
help text: The instance name of our local authorizer used as our gateway. If using direct communication, this field is ignored.

Constructor Detail

IODeclBaseStruct

public IODeclBaseStruct()