Class CMIPObj

Class CMIPObj

java.lang.Object
   |
   +----Information
        |
        +----CMIPObj

public class CMIPObj
extends Information
This class implements some custom functions on top of Information in order to make easier the interaction with CMIP objects.

To know about how the CMIPObj works, please read the following paper: Network Management for the 90s.

See Also:
Information, Proxy

Constructor Index

 o CMIPObj(String aet)

Method Index

 o SetAgentAET(String aet)
Set the AE-Title used to locate the CMIP agent.
 o SetObjectClass(String val)
Set the object class.
 o GetObjectClass()
Return the object class.
 o SetObjectInstance(String val)
Set the object instance.
 o GetObjectInstance()
Return the object instance.
 o CMIPCreateObject()
Issue the CMIP Create request for the specified instance.
 o CMIPDeleteObject()
Issue the CMIP Delete request for the specified instance.
 o CMIPDeleteContainedInstances()
Issue the CMIP Delete request for the specified instance and its subinstances (scoped request).
 o CMIPGetObject()
Issue the CMIP Get request for the specified instance.
 o CMIPGetContainedInstances()
Issue the CMIP Get request for the specified instance and its subinstances (scoped request).
 o CMIPSetObject()
Issue the CMIP Set request for the specified instance.
 o CMIPSetContainedInstances()
Issue the CMIP Set request for the specified instance and its subinstances (scoped request).
 o CMIPPerformAction()
Issue the CMIP Action request for the specified instance.
 o CMIPPerformActionContainedInstances()
Issue the CMIP Actione request for the specified instance and its subinstances (scoped request).
 o NotificationsAvailable()
Check whether there are CMIP EventReports available.
 o WaitForNotifications(int timeout)
Wait for notifications up to a specified amount of time.
 o CreateEFD(String sysInst, String filter)
Create an EFD used to receive notifications.
 o DeleteEFD()
Delete the EFD created using the method above.
 o GetActions()
Return all the actions that can be performed on the specified instance.
 o GetNameBindings()
Return all the name bindings that can be used to create instances contained in the specified instance.
 o GetSyntaxInfo(String oid)
Return the ASN.1 syntax corresponding to the specified OID.
 o ConvertOID(String oid)
Convert an OID from numeric to symbolic form and viceversa.
 o toString()
Covert the instance to a String. Mostly used in order to print the instance.

Constructors

 o CMIPObj
  public CMIPObj(String aet)
Create a CMIPObj instance.
Parameters:
aet - CMIP agent's AE-Title

Methods

 o SetAgentAET
  public void SetAgentAET(String aet)
Set the AE-Title used to locate the CMIP agent.
Parameters:
aet - the AE-Title value.
 o SetObjectClass
  public void SetObjectClass(String val)
Set the object class.
Parameters:
val - the object class value (either numeric or symbolic form).
 o GetObjectClass
  public String GetObjectClass()
Get the object class.
Returns:
the object class of the specified instance , if any.
 o SetObjectInstance
  public void SetObjectInstance(String val)
Set the object Instance.
Parameters:
val - the object instance value (either numeric or symbolic form).
 o GetObjectInstance
  public String GetObjectInstance()
Get the object instance.
Returns:
the object instance of the specified instance, if any.
 o CMIPCreateObject
  public void CMIPCreateObject() throws ProxyException
Issue the CMIP Create request for the specified instance. The response is stored inside the instance itself.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o CMIPDeleteObject
  public void CMIPDeleteObject() throws ProxyException
Issue the CMIP Delete request for the specified instance. The response is stored inside the instance itself.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o CMIPDeleteContainedInstances
  public Vector CMIPDeleteContainedInstances() throws ProxyException
Issue the CMIP Delete request for the specified instance and its subinstances (scoped request).
Returns:
A vector contained the responses received in front of the request.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request
 o CMIPGetObject
  public void CMIPGetObject() throws ProxyException
Issue the CMIP Get request for the specified instance. The response is stored inside the instance itself.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request
 o CMIPGetContainedInstances
  public Vector CMIPGetContainedInstances() throws ProxyException
Issues the CMIP Get request for the specified instance and its subinstances (scoped request).
Returns:
A vector contained the responses received in front of the request.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o CMIPSetObject
  public void CMIPSetObject() throws ProxyException
Issue the CMIP Set request for the specified instance. The response is stored inside the instance itself.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o CMIPSetContainedInstances
  public Vector CMIPSetContainedInstances() throws ProxyException
Issue the CMIP Set request for the specified instance and its subinstances (scoped request).
Returns:
A vector contained the responses received in front of the request.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o CMIPPerformAction
  public void CMIPPerformAction() throws ProxyException
Issue the CMIP Action request for the specified instance. The response is stored inside the instance itself.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o CMIPPerformActionContainedInstances
  public Vector CMIPPerformActionContainedInstances() throws ProxyException
Issue the CMIP Action request for the specified instance and its subinstances (scoped request).
Returns:
A vector contained the responses received in front of the request.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o NotificationsAvailable
  public int NotificationsAvailable() throws ProxyException
Check whether there are CMIP EventReports available.
Returns:
The number of notifications currently available.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison.
 o WaitForNotifications
  public Information WaitForNotifications(int timeout) throws ProxyException
Wait for notifications up to a specified amount of time.
Parameters:
timeout - the timeout in seconds (-1 stands for infinite timeout).
Returns:
A notification, if any, received within the specified timeout.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison.
 o CreateEFD
  public void CreateEFD(String sysInst, String filter) throws ProxyException
Create an EFD used to receive notifications.
Parameters:
sysInst - the object instance which will contain the EFD
filter - the value of EFD's discriminatorConstruct attribute
Returns:
A notification, if any, received within the specified timeout.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o DeleteEFD
  public void DeleteEFD() throws ProxyException
Delete the EFD created using the method above.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison or if a CMIP error has been generated in front of the request.
 o GetActions
  public Information GetActions() throws ProxyException
Return all the actions that can be performed on the specified instance.
Returns:
The CMIP actions that can be performed by the specified instance.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison.
 o GetNameBindings
  public Information GetNameBindings() throws ProxyException
Returns all the name bindings that can be used to create instances contained in the specified instance.
Returns:
The name bindings allowed for the subinstances of the specified instance.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison.
 o GetSyntaxInfo
  public String GetSyntaxInfo(String oid) throws ProxyException
Returns the ASN.1 syntax corresponding to the specified OID in HTML format.
Parameters:
oid - The ASN.1 type corresponding to the specified OID which must be expressed in numeric form (if you need to convert an OID use the ConvertOID method.
Returns:
The name bindings allowed for the subinstances of the specified instance.
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison
 o ConvertOID
  public String ConvertOID(String oid) throws ProxyException
Converts an OID from numeric to symbolic form and viceversa.
Parameters:
The OID to convert
Returns:
The converted OID
Throws:
ProxyException - In case the Proxy instance reported some problems during the communication with Liaison.
 o toString
  public synchronized String toString()
Coverts the instance to a String.

Last modified: Thu Mar 6 13:53:10 MET 1997