com.edustructures.sifworks.infra
Class SIF_SIFNode

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_SIFNode

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_SIFNode
extends SIFKeyedElement

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_SIFNode()
Constructor

SIF_SIFNode(SIF_SIFNodeType type, java.lang.String sifName, java.lang.String sifSourceId, SIFMode sifMode, java.lang.Integer sifMaxBufferSize, YesNo sifSleeping)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
SIF_Application	getSIF_Application() Gets the value of the <SIF_Application> element.
java.lang.String	getSIF_AuthenticationLevel() Gets the value of the <SIF_AuthenticationLevel> element.
java.lang.String	getSIF_DynamicConnectionData() Gets the value of the <SIF_DynamicConnectionData> element.
java.lang.String	getSIF_EncryptionLevel() Gets the value of the <SIF_EncryptionLevel> element.
java.lang.String	getSIF_Icon() Gets the value of the <SIF_Icon> element.
java.lang.Integer	getSIF_MaxBufferSize() Gets the value of the <SIF_MaxBufferSize> element.
java.lang.String	getSIF_Mode() Gets the value of the <SIF_Mode> element.
java.lang.String	getSIF_Name() Gets the value of the <SIF_Name> element.
java.lang.String	getSIF_NodeVendor() Gets the value of the <SIF_NodeVendor> element.
java.lang.String	getSIF_NodeVersion() Gets the value of the <SIF_NodeVersion> element.
SIF_Protocol	getSIF_Protocol() Gets the value of the <SIF_Protocol> element.
java.lang.String	getSIF_Sleeping() Gets the value of the <SIF_Sleeping> element.
java.lang.String	getSIF_SourceId() Gets the value of the <SIF_SourceId> element.
SIF_VersionList	getSIF_VersionList() Gets the value of the <SIF_VersionList> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeSIF_Application() Removes the SIF_Application child element previously created by calling setSIF_Application
void	removeSIF_Protocol() Removes the SIF_Protocol child element previously created by calling setSIF_Protocol
void	removeSIF_VersionList() Removes the SIF_VersionList child element previously created by calling setSIF_VersionList
void	setSIF_Application(SIF_Application value) Sets the value of the <SIF_Application> element.
void	setSIF_Application(java.lang.String sifVendor, java.lang.String sifProduct, java.lang.String sifVersion) Sets the value of the <SIF_Application> child element.
void	setSIF_AuthenticationLevel(AuthenticationLevel value) Sets the value of the <SIF_AuthenticationLevel> element.
void	setSIF_AuthenticationLevel(java.lang.String value) Sets the value of the <SIF_AuthenticationLevel> element as a String.
void	setSIF_DynamicConnectionData(java.lang.String value) Sets the value of the <SIF_DynamicConnectionData> element.
void	setSIF_EncryptionLevel(EncryptionLevel value) Sets the value of the <SIF_EncryptionLevel> element.
void	setSIF_EncryptionLevel(java.lang.String value) Sets the value of the <SIF_EncryptionLevel> element as a String.
void	setSIF_Icon(java.lang.String value) Sets the value of the <SIF_Icon> element.
void	setSIF_MaxBufferSize(java.lang.Integer value) Sets the value of the <SIF_MaxBufferSize> element.
void	setSIF_Mode(SIFMode value) Sets the value of the <SIF_Mode> element.
void	setSIF_Mode(java.lang.String value) Sets the value of the <SIF_Mode> element as a String.
void	setSIF_Name(java.lang.String value) Sets the value of the <SIF_Name> element.
void	setSIF_NodeVendor(java.lang.String value) Sets the value of the <SIF_NodeVendor> element.
void	setSIF_NodeVersion(java.lang.String value) Sets the value of the <SIF_NodeVersion> element.
void	setSIF_Protocol(SIF_Protocol value) Sets the value of the <SIF_Protocol> element.
void	setSIF_Protocol(java.lang.String type, YesNo secure) Sets the value of the <SIF_Protocol> child element.
void	setSIF_Sleeping(java.lang.String value) Sets the value of the <SIF_Sleeping> element as a String.
void	setSIF_Sleeping(YesNo value) Sets the value of the <SIF_Sleeping> element.
void	setSIF_SourceId(java.lang.String value) Sets the value of the <SIF_SourceId> element.
void	setSIF_VersionList(SIF_VersionList value) Sets the value of the <SIF_VersionList> element.
void	setType(SIF_SIFNodeType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SIF_SIFNode

public SIF_SIFNode()

Constructor

SIF_SIFNode

public SIF_SIFNode(SIF_SIFNodeType type,
                   java.lang.String sifName,
                   java.lang.String sifSourceId,
                   SIFMode sifMode,
                   java.lang.Integer sifMaxBufferSize,
                   YesNo sifSleeping)

Constructor that accepts values for all mandatory fields

Parameters:

type - The type of node ("Agent" or "ZIS")

sifName - The descriptive name of the SIF node (i.e. Ramsey Food Services).

sifSourceId - The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create.

sifMode - Specifies the communication mode (Pull or Push) as chosen by the message sender.

sifMaxBufferSize - Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message.

sifSleeping - This element shows whether the SIF node is ready to process messages.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The type of node ("Agent" or "ZIS")"

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(SIF_SIFNodeType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The type of node ("Agent" or "ZIS")"

Parameters:

value - A constant defined by the SIF_SIFNodeType class

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "The type of node ("Agent" or "ZIS")"

Parameters:

value - The value as a String

Since:

1.1

getSIF_Name

public java.lang.String getSIF_Name()

Gets the value of the <SIF_Name> element.

The SIF specification defines the meaning of this element as: "The descriptive name of the SIF node (i.e. Ramsey Food Services)."

Returns:

The SIF_Name element of this object.

Since:

1.1

setSIF_Name

public void setSIF_Name(java.lang.String value)

Sets the value of the <SIF_Name> element.

The SIF specification defines the meaning of this element as: "The descriptive name of the SIF node (i.e. Ramsey Food Services)."

Parameters:

value - A String object

Since:

1.1

getSIF_Icon

public java.lang.String getSIF_Icon()

Gets the value of the <SIF_Icon> element.

The SIF specification defines the meaning of this element as: " HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). Agents may optionally follow the more restrictive guidelines at [FAVICON]. "

Returns:

The SIF_Icon element of this object.

Since:

2.0

setSIF_Icon

public void setSIF_Icon(java.lang.String value)

Sets the value of the <SIF_Icon> element.

The SIF specification defines the meaning of this element as: " HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). Agents may optionally follow the more restrictive guidelines at [FAVICON]. "

Parameters:

value - A String object

Since:

2.0

getSIF_SourceId

public java.lang.String getSIF_SourceId()

Gets the value of the <SIF_SourceId> element.

The SIF specification defines the meaning of this element as: "The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create."

Returns:

The SIF_SourceId element of this object.

Since:

1.1

setSIF_SourceId

public void setSIF_SourceId(java.lang.String value)

Sets the value of the <SIF_SourceId> element.

The SIF specification defines the meaning of this element as: "The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create."

Parameters:

value - A String object

Since:

1.1

getSIF_NodeVendor

public java.lang.String getSIF_NodeVendor()

Gets the value of the <SIF_NodeVendor> element.

The SIF specification defines the meaning of this element as: "The vendor of the SIF agent."

Returns:

The SIF_NodeVendor element of this object.

Since:

2.0

setSIF_NodeVendor

public void setSIF_NodeVendor(java.lang.String value)

Sets the value of the <SIF_NodeVendor> element.

The SIF specification defines the meaning of this element as: "The vendor of the SIF agent."

Parameters:

value - A String object

Since:

2.0

getSIF_Mode

public java.lang.String getSIF_Mode()

Gets the value of the <SIF_Mode> element.

The SIF specification defines the meaning of this element as: "Specifies the communication mode (Pull or Push) as chosen by the message sender."

Returns:

The SIF_Mode element of this object.

Since:

1.1

setSIF_Mode

public void setSIF_Mode(SIFMode value)

Sets the value of the <SIF_Mode> element.

The SIF specification defines the meaning of this element as: "Specifies the communication mode (Pull or Push) as chosen by the message sender."

Parameters:

value - A constant defined by the SIFMode class

Since:

1.1

setSIF_Mode

public void setSIF_Mode(java.lang.String value)

Sets the value of the <SIF_Mode> element as a String.

The SIF specification defines the meaning of this element as: "Specifies the communication mode (Pull or Push) as chosen by the message sender."

Parameters:

value - The value as a String

Since:

1.1

setSIF_Protocol

public void setSIF_Protocol(SIF_Protocol value)

Sets the value of the <SIF_Protocol> element.

The SIF specification defines the meaning of this element as: "Describes the currently active protocol that the SIF_SIFNode is using to communicate with the ZIS."

Parameters:

value - A SIF_Protocol object

Since:

1.1

setSIF_Protocol

public void setSIF_Protocol(java.lang.String type,
                            YesNo secure)

Sets the value of the <SIF_Protocol> child element. This form of setSIF_Protocol is provided as a convenience method that is functionally equivalent to the version of setSIF_Protocol that accepts a single SIF_Protocol object.

Parameters:

type - Identifies the type being used (e.g. "HTTP", "HTTPS", "MSMQ", etc.)

secure - Indicates if the protocol provides a secure channel

Since:

1.1

getSIF_Protocol

public SIF_Protocol getSIF_Protocol()

Gets the value of the <SIF_Protocol> element.

The SIF specification defines the meaning of this element as: "Describes the currently active protocol that the SIF_SIFNode is using to communicate with the ZIS."

Returns:

A SIF_Protocol object

Since:

1.1

removeSIF_Protocol

public void removeSIF_Protocol()

Removes the SIF_Protocol child element previously created by calling setSIF_Protocol

Since:

1.1

getSIF_NodeVersion

public java.lang.String getSIF_NodeVersion()

Gets the value of the <SIF_NodeVersion> element.

The SIF specification defines the meaning of this element as: " The agent version number. The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. "

Returns:

The SIF_NodeVersion element of this object.

Since:

2.0

setSIF_NodeVersion

public void setSIF_NodeVersion(java.lang.String value)

Sets the value of the <SIF_NodeVersion> element.

The SIF specification defines the meaning of this element as: " The agent version number. The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. "

Parameters:

value - A String object

Since:

2.0

setSIF_Application

public void setSIF_Application(SIF_Application value)

Sets the value of the <SIF_Application> element.

Parameters:

value - A SIF_Application object

Since:

2.0

setSIF_Application

public void setSIF_Application(java.lang.String sifVendor,
                               java.lang.String sifProduct,
                               java.lang.String sifVersion)

Sets the value of the <SIF_Application> child element. This form of setSIF_Application is provided as a convenience method that is functionally equivalent to the version of setSIF_Application that accepts a single SIF_Application object.

Parameters:

sifVendor - The name of the company of the product that this agent supports.

sifProduct - The name of the product that this agent supports.

sifVersion - The version of the product. This field is informative only.

Since:

2.0

getSIF_Application

public SIF_Application getSIF_Application()

Gets the value of the <SIF_Application> element.

Returns:

A SIF_Application object

Since:

2.0

removeSIF_Application

public void removeSIF_Application()

Removes the SIF_Application child element previously created by calling setSIF_Application

Since:

2.0

setSIF_VersionList

public void setSIF_VersionList(SIF_VersionList value)

Sets the value of the <SIF_VersionList> element.

The SIF specification defines the meaning of this element as: "The version of the SIF specification that the SIF_SIFNode uses"

Parameters:

value - A SIF_VersionList object

Since:

1.1

getSIF_VersionList

public SIF_VersionList getSIF_VersionList()

Gets the value of the <SIF_VersionList> element.

The SIF specification defines the meaning of this element as: "The version of the SIF specification that the SIF_SIFNode uses"

Returns:

A SIF_VersionList object

Since:

1.1

removeSIF_VersionList

public void removeSIF_VersionList()

Removes the SIF_VersionList child element previously created by calling setSIF_VersionList

Since:

1.1

getSIF_AuthenticationLevel

public java.lang.String getSIF_AuthenticationLevel()

Gets the value of the <SIF_AuthenticationLevel> element.

The SIF specification defines the meaning of this element as: "This is the level of authentication that the SIF node supports when it wants to communicate via a secure channel."

Returns:

The SIF_AuthenticationLevel element of this object.

Since:

1.1

setSIF_AuthenticationLevel

public void setSIF_AuthenticationLevel(AuthenticationLevel value)

Sets the value of the <SIF_AuthenticationLevel> element.

The SIF specification defines the meaning of this element as: "This is the level of authentication that the SIF node supports when it wants to communicate via a secure channel."

Parameters:

value - A constant defined by the AuthenticationLevel class

Since:

1.1

setSIF_AuthenticationLevel

public void setSIF_AuthenticationLevel(java.lang.String value)

Sets the value of the <SIF_AuthenticationLevel> element as a String.

The SIF specification defines the meaning of this element as: "This is the level of authentication that the SIF node supports when it wants to communicate via a secure channel."

Parameters:

value - The value as a String

Since:

1.1

getSIF_EncryptionLevel

public java.lang.String getSIF_EncryptionLevel()

Gets the value of the <SIF_EncryptionLevel> element.

The SIF specification defines the meaning of this element as: "This is the level of encryption that the SIF node supports when it wants to communicate via a secure channel."

Returns:

The SIF_EncryptionLevel element of this object.

Since:

1.1

setSIF_EncryptionLevel

public void setSIF_EncryptionLevel(EncryptionLevel value)

Sets the value of the <SIF_EncryptionLevel> element.

The SIF specification defines the meaning of this element as: "This is the level of encryption that the SIF node supports when it wants to communicate via a secure channel."

Parameters:

value - A constant defined by the EncryptionLevel class

Since:

1.1

setSIF_EncryptionLevel

public void setSIF_EncryptionLevel(java.lang.String value)

Sets the value of the <SIF_EncryptionLevel> element as a String.

The SIF specification defines the meaning of this element as: "This is the level of encryption that the SIF node supports when it wants to communicate via a secure channel."

Parameters:

value - The value as a String

Since:

1.1

getSIF_MaxBufferSize

public java.lang.Integer getSIF_MaxBufferSize()

Gets the value of the <SIF_MaxBufferSize> element.

The SIF specification defines the meaning of this element as: "Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message."

Returns:

The SIF_MaxBufferSize element of this object.

Since:

1.1

setSIF_MaxBufferSize

public void setSIF_MaxBufferSize(java.lang.Integer value)

Sets the value of the <SIF_MaxBufferSize> element.

The SIF specification defines the meaning of this element as: "Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message."

Parameters:

value - A Integer object

Since:

1.1

getSIF_Sleeping

public java.lang.String getSIF_Sleeping()

Gets the value of the <SIF_Sleeping> element.

The SIF specification defines the meaning of this element as: "This element shows whether the SIF node is ready to process messages."

Returns:

The SIF_Sleeping element of this object.

Since:

1.1

setSIF_Sleeping

public void setSIF_Sleeping(YesNo value)

Sets the value of the <SIF_Sleeping> element.

The SIF specification defines the meaning of this element as: "This element shows whether the SIF node is ready to process messages."

Parameters:

value - A constant defined by the YesNo class

Since:

1.1

setSIF_Sleeping

public void setSIF_Sleeping(java.lang.String value)

Sets the value of the <SIF_Sleeping> element as a String.

The SIF specification defines the meaning of this element as: "This element shows whether the SIF node is ready to process messages."

Parameters:

value - The value as a String

Since:

1.1

getSIF_DynamicConnectionData

public java.lang.String getSIF_DynamicConnectionData()

Gets the value of the <SIF_DynamicConnectionData> element.

The SIF specification defines the meaning of this element as: "Encompasses the statistics that the ZIS maintains for each SIF_SIFNode. No child elements have been defined in version 1.0 of the specification."

Returns:

The SIF_DynamicConnectionData element of this object.

Since:

1.1

setSIF_DynamicConnectionData

public void setSIF_DynamicConnectionData(java.lang.String value)

Sets the value of the <SIF_DynamicConnectionData> element.

The SIF specification defines the meaning of this element as: "Encompasses the statistics that the ZIS maintains for each SIF_SIFNode. No child elements have been defined in version 1.0 of the specification."

Parameters:

value - A String object

Since:

1.1