Package net.aifusion.cimserver

Enum CimXHeader

java.lang.Object
java.lang.Enum<CimXHeader>
net.aifusion.cimserver.CimXHeader
All Implemented Interfaces:
Serializable, Comparable<CimXHeader>, java.lang.constant.Constable
public enum CimXHeader extends Enum<CimXHeader>
Http CIM Extension Headers known to the server. These extension headers are used to identify parameters for intrinsic operations requested by the client
Author:
Sharad Singhal

  • Enum Constant Details

    • INTRINSIC

      public static final CimXHeader INTRINSIC
      Intrinsic Operation being performed (see CimHeader)

    • OBJECT_PATH

      public static final CimXHeader OBJECT_PATH
      header containing the object path of the named element

    • NAMESPACE_PATH

      public static final CimXHeader NAMESPACE_PATH
      Header containing the name space path

    • METHOD_NAME

      public static final CimXHeader METHOD_NAME
      Name of the extrinsic method being addressed

    • METHOD_TYPE

      public static final CimXHeader METHOD_TYPE
      Data type of the return value for an extrinsic method

    • PROPERTY_NAME

      public static final CimXHeader PROPERTY_NAME
      Name of the property being addressed

    • PROPERTY_TYPE

      public static final CimXHeader PROPERTY_TYPE
      Type of the property being set

    • PARAMETER_NAME

      public static final CimXHeader PARAMETER_NAME
      Name of the parameter being addressed

    • ELEMENT_TYPES

      public static final CimXHeader ELEMENT_TYPES
      List of element types being requested in getElements

    • FILTER_STRING

      public static final CimXHeader FILTER_STRING
      Filter query string sent using CimFilter

    • NAME_SPACES

      public static final CimXHeader NAME_SPACES
      List of namespaces being requested in getElements

    • ELEMENT_NAMES

      public static final CimXHeader ELEMENT_NAMES
      List of element names being requested in getElements

    • LOCATE_SUBCLASS

      public static final CimXHeader LOCATE_SUBCLASS
      Flag identifying if subclasses should be searched for getElements

    • EVENT_TYPE

      public static final CimXHeader EVENT_TYPE
      Type of event associated with a listener

    • CIM_URL

      public static final CimXHeader CIM_URL
      URL for the listener

  • Method Details

    • values

      public static CimXHeader[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CimXHeader valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • appliesTo

      public boolean appliesTo(CimHeader h)
      Test if this extension header should accompany a given CimHeader.
      Parameters:
      h - - header to test
      Returns:
      - true if this parameter applies to the given header, false otherwise

    • getXHeaders

      public static List<CimXHeader> getXHeaders(CimHeader h)
      Get all valid extension headers that should accompany a given CimHeader.
      Parameters:
      h - - header to test
      Returns:
      - parameters appropriate for that header

    • lookup

      public static CimXHeader lookup(String value)
      Get the extension header corresponding to a string header value
      Parameters:
      value - - string value for the header (case insensitive)
      Returns:
      - corresponding extension header, null if no such header exists

    • toString

      public String toString()
      Overrides:
      toString in class Enum<CimXHeader>