Overview  Package   Class  Tree  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.wbem.provider
Interface AssociatorProvider

All Superinterfaces:
Provider
public interface AssociatorProvider
extends Provider

This interface is implemented by providers that provide dynamic association instances. The WBEM Server invokes these methods when it performs association traversal operations.

Since:
JSR48 1.0.0

Method Summary
 CloseableIterator associatorNames(CIMObjectPath assocName, CIMObjectPath objectName, java.lang.String resultClass, java.lang.String role, java.lang.String resultRole)
          This method is used to enumerate the names of CIM Instances that are associated to a particular source CIM Instance.
 CloseableIterator associators(CIMObjectPath assocName, CIMObjectPath objectName, java.lang.String resultClass, java.lang.String role, java.lang.String resultRole, boolean includeClassOrigin, java.lang.String[] propertyList)
          This method is used to enumerate CIM Instances that are associated to a particular source CIM Instance.
 CloseableIterator referenceNames(CIMObjectPath assocName, CIMObjectPath objectName, java.lang.String role)
          This method is used to enumerate the association objects that refer to a particular target CIM Instance.
 CloseableIterator references(CIMObjectPath assocName, CIMObjectPath objectName, java.lang.String role, boolean includeClassOrigin, java.lang.String[] propertyList)
          This method is used to enumerate the association objects that refer to a particular target CIM Instance.
 
Methods inherited from interface javax.wbem.provider.Provider
close, initialize
 

Method Detail

associatorNames

public CloseableIterator associatorNames(CIMObjectPath assocName,
                                         CIMObjectPath objectName,
                                         java.lang.String resultClass,
                                         java.lang.String role,
                                         java.lang.String resultRole)
                                  throws WBEMException
This method is used to enumerate the names of CIM Instances that are associated to a particular source CIM Instance. The object paths to the instances associated to the specified instance are returned. This method is invoked in order to perform the AssociatorNames operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/

Parameters:
assocName - Defines the association that the objectName Object should be associated to. The provider uses this information to identify which association must be traversed in case it supports more than one association.
objectName - Defines the source CIM Object whose associated Objects are to be returned. This is an Instance name (modelpath).
resultClass - The ResultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be an object path to each Instance of this Class or one of its subclasses.
role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter). Thus, if the Role input parameter is set to Antecedent, then only Associations where the source Object is the Antecedent reference are examined. NOTE: The source Object is the objectName input parameter.
resultRole - The ResultRole input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter). Thus, if the resultRole input parameter is set to Dependent, then only Associations where the returned Object is the Dependent reference are examined. NOTE: The source Object is the objectName input parameter.
Returns:
If successful, the method returns a CloseableIterator of CIMObjectPath meeting the requested criteria. If no Instances are found, then the Provider NULL must be returned.
Throws:
WBEMException - If unsuccessful, one of the following status codes may be returned. The ORDERED list is:
  • CIM_ERR_ACCESS_DENIED
  • CIM_ERR_NOT_SUPPORTED
  • CIM_ERR_INVALID_NAMESPACE
  • CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters)
  • CIM_ERR_FAILED (some other unspecified error occurred)

associators

public CloseableIterator associators(CIMObjectPath assocName,
                                     CIMObjectPath objectName,
                                     java.lang.String resultClass,
                                     java.lang.String role,
                                     java.lang.String resultRole,
                                     boolean includeClassOrigin,
                                     java.lang.String[] propertyList)
                              throws WBEMException
This method is used to enumerate CIM Instances that are associated to a particular source CIM Instance. The entire instances associated to the specified instance are returned. This method is invoked in order to perform the Associators operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/

Parameters:
assocName - Defines the association that the objectName Object should be associated to. The provider uses this information to identify which association must be traversed in case it supports more than one association.
objectName - Defines the source CIM Object whose associated Objects are to be returned. This is an instance name (modelpath).
resultClass - The ResultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be an Instance of this Class or one of its subclasses.
role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter). Thus, if the Role input parameter is set to Antecedent, then only Associations where the source Object is the Antecedent reference are examined. NOTE: The source Object is the objectName input parameter.
resultRole - The resultRole input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter). Thus, if the resultRole input parameter is set to Dependent, then only Associations where the returned Object is the Dependent reference are examined. NOTE: The source Object is the objectName input parameter.
includeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class Origin attribute will be present for each property and method on all Objects returned. If false, the class origin will not be present.
propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Instance MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true this acts as an additional filter on the set of Properties returned (e.g. if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Instance. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Instance. The PropertyList may contain duplicate or invalid Property names. The Provider must ignore them but otherwise process the request normally; i.e. the returned Instance(s) will not contain duplicate or invalid Property Names. Clients SHOULD NOT explicitly specify properties in the PropertyList parameter unless they have specified a non-NULL value for the ResultClass parameter.
Returns:
If successful, the method returns a CloseableIterator of CIMInstances meeting the requested criteria. If no Instances are found, then the Provider NULL must be returned.
Throws:
WBEMException - If unsuccessful, one of the following status codes may be returned. The ORDERED list is:
  • CIM_ERR_ACCESS_DENIED
  • CIM_ERR_NOT_SUPPORTED
  • CIM_ERR_INVALID_NAMESPACE
  • CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters)
  • CIM_ERR_FAILED (some other unspecified error occurred)

referenceNames

public CloseableIterator referenceNames(CIMObjectPath assocName,
                                        CIMObjectPath objectName,
                                        java.lang.String role)
                                 throws WBEMException
This method is used to enumerate the association objects that refer to a particular target CIM Instance. The object paths to association instances are returned. This method is invoked in order to perform the ReferenceNames operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/

Parameters:
assocName - Defines the association that the objectName object should be associated to. The provider uses this information to identify which association must be traversed in case it supports more than one association.
objectName - Defines the target CIM Object whose associated Objects are to be returned. This is an Instance name (modelpath).
role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Association Instances by mandating that each returned Association Instance MUST refer to the target Instance in which the target Instance plays the specified role (i.e. the name of the Property in the Association Instance that refers to the target Instance MUST match the value of this parameter). Thus, if Role input parameter is set to Antecedent, only Association Instances where target Instance is the Antecedent reference are returned. NOTE: The target Instance is the objectName input parameter.
Returns:
If successful, the method returns a CloseableIterator of CIMObjectPaths meeting the requested criteria. If no Instances are found, then the Provider NULL must be returned.
Throws:
WBEMException - If unsuccessful, one of the following status codes may be returned. The ORDERED list is:
  • CIM_ERR_ACCESS_DENIED
  • CIM_ERR_NOT_SUPPORTED
  • CIM_ERR_INVALID_NAMESPACE
  • CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters)
  • CIM_ERR_FAILED (some other unspecified error occurred)

references

public CloseableIterator references(CIMObjectPath assocName,
                                    CIMObjectPath objectName,
                                    java.lang.String role,
                                    boolean includeClassOrigin,
                                    java.lang.String[] propertyList)
                             throws WBEMException
This method is used to enumerate the association objects that refer to a particular target CIM Instance. Entire association instances are returned. This method is invoked in order to perform the References operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/

Parameters:
assocName - Defines the association that the objectName Object should be associated to. The provider uses this information to identify which association must be traversed in case it supports more than one association.
objectName - Defines the source CIM Object whose associated Objects are to be returned. This is an Instance name (modelpath).
role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Association Instances by mandating that each returned Association Instance MUST refer to the target Instance in which the target Instance plays the specified role (i.e. the name of the Property in the Association Instance that refers to the target Instance MUST match the value of this parameter). Thus, if Role input parameter is set to Antecedent, only Association Instances where target Instance is the Antecedent reference are returned. NOTE: The target Instance is the objectName input parameter.
propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Instance MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true this acts as an additional filter on the set of Properties returned (e.g. if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Instance. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Instance. The PropertyList may contain duplicate or invalid Property names. The Provider must ignore them but otherwise process the request normally; i.e. the returned Instance(s) will not contain duplicate or invalid Property Names. Clients SHOULD NOT explicitly specify properties in the PropertyList parameter unless they have specified a non-NULL value for the ResultClass parameter.
includeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class Origin attribute will be present for each property and method on all Objects returned. If false, the class origin will not be present.
Returns:
If successful, the method returns a CloseableIterator of CIMInstances meeting the requested criteria. If no Instances exist, then the Provider NULL must be returned.
Throws:
WBEMException - If unsuccessful, one of the following status codes may be returned. The ORDERED list is:
  • CIM_ERR_ACCESS_DENIED
  • CIM_ERR_NOT_SUPPORTED
  • CIM_ERR_INVALID_NAMESPACE
  • CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters)
  • CIM_ERR_FAILED (some other unspecified error occurred)
Overview  Package   Class  Tree  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Java™ WBEM (JSR48) 1.0.0 API