ch.ecma.csta.binding
Class SystemRegister

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.SystemRegister

All Implemented Interfaces:

java.io.Serializable

public class SystemRegister
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Not supported.

Registers the computing function for system services with the switching function.Used by the computing function to register to receive system services from the switching function. The computing function may be required to register for system services before it can receive any system service requests from the switching function.

CSTA Functional Implementation:

1. The sysStatRegisterID parameter returned in the positive acknowledgement is used to identify the registration over which system services will be sent. The sysStatRegisterID is also used when cancelling the system registration.
2. The number of simultaneous system registrations allowed is switching function dependent. When the limit is reached, subsequent System Register service requests will result in negative acknowledgements from the switching function.
3. The requestTypes parameter specifies which system services are to be issued by the switching function to the registering computing function.
4. The requestedStatusFilter parameter allows the computing function to choose the System Status Types for which no SystemStatus service requests should be issued by the switching function. If the System Status service is not being requested (in the requestTypes parameter), then the actualStatusFilter parameter does not apply and will not be provided. The actual system status filter is provided in the actualStatusFilter parameter in the positive acknowledgement.
5. An implementation that does not support all System Status Types will nevertheless accept the System Register service even if the requestedStatusFilter cannot be provided. The service acknowledgement indicates the actual set of System Status Types that will be filtered. This means that the actual set of filtered types returned in the positive acknowledgement may include additional types to be filtered (or fewer types generated by the switching function) than what was requested in the service request.
6. If explicit registration is not supported, all system services (for example, System Status, Request System Status) and System Status Types (for example, Initializing, Enabled) supported by the switching function will be provided to the computing functions. Note that the computing function will be prepared to respond to a System Status service request from the switching function in such cases (because it has no way of specifying that it should not receive such requests).
7. Note that if a computing function registers for system services it will support the ability to respond to any switching function System Status service requests it may receive. In particular, for implicit registrations, a CSTA-conformant computing function will always be able to support such requests from the switching function.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SystemRegister()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
StatusFilter	getRequestedStatusFilter() Returns the value of field 'requestedStatusFilter'.
RequestTypes	getRequestTypes() Returns the value of field 'requestTypes'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setRequestedStatusFilter(StatusFilter requestedStatusFilter) Sets the value of field 'requestedStatusFilter'.
void	setRequestTypes(RequestTypes requestTypes) Sets the value of field 'requestTypes'.
static SystemRegister	unmarshalSystemRegister(java.io.Reader reader) Method unmarshalSystemRegister
void	validate() Method validate

Methods inherited from class ch.ecma.csta.CastorObject

getOldSessionID, hashCode, setOldSessionID, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SystemRegister

public SystemRegister()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

Returns:

boolean

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getRequestTypes

public RequestTypes getRequestTypes()

Returns the value of field 'requestTypes'. The field 'requestTypes' has the following description: Specifies the system services that are being registered. Mandatory.

This parameter is a bitmap of the following values:

• System Status
• Request System Status
• Switching Function Capabilities Changed
• Switching Function Devices Changed

Multiple bits may be set.

Returns:

RequestTypes

getRequestedStatusFilter

public StatusFilter getRequestedStatusFilter()

Returns the value of field 'requestedStatusFilter'. The field 'requestedStatusFilter' has the following description: Specifies the requested set of System Status Types to be filtered (not sent) by the switching function.

This parameter is a bitmap of the following values:

• Initializing
• Enabled
• Normal
• Messages Lost
• Disabled
• Partially Disabled
• Overload Imminent
• Overload Reached
• Overload Relieved

Multiple bits may be set.

This parameter is mandatory if the requestTypes parameter includes System Status, otherwise it will not be provided.

Returns:

StatusFilter

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setRequestTypes

public void setRequestTypes(RequestTypes requestTypes)

Sets the value of field 'requestTypes'. The field 'requestTypes' has the following description: Specifies the system services that are being registered. Mandatory.

This parameter is a bitmap of the following values:

• System Status
• Request System Status
• Switching Function Capabilities Changed
• Switching Function Devices Changed

Multiple bits may be set.

Parameters:

requestTypes - the value of field 'requestTypes'.

setRequestedStatusFilter

public void setRequestedStatusFilter(StatusFilter requestedStatusFilter)

Sets the value of field 'requestedStatusFilter'. The field 'requestedStatusFilter' has the following description: Specifies the requested set of System Status Types to be filtered (not sent) by the switching function.

This parameter is a bitmap of the following values:

• Initializing
• Enabled
• Normal
• Messages Lost
• Disabled
• Partially Disabled
• Overload Imminent
• Overload Reached
• Overload Relieved

Multiple bits may be set.

This parameter is mandatory if the requestTypes parameter includes System Status, otherwise it will not be provided.

Parameters:

requestedStatusFilter - the value of field 'requestedStatusFilter'.

unmarshalSystemRegister

public static SystemRegister unmarshalSystemRegister(java.io.Reader reader)
                                              throws org.exolab.castor.xml.MarshalException,
                                                     org.exolab.castor.xml.ValidationException

Method unmarshalSystemRegister

Parameters:

reader -

Returns:

SystemRegister

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException