Interface IArgBlock

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArgBlock
public interface IArgBlock extends Serializable
This interface defines the abstraction for the generic collection of attributes indexed by string names. Set of cooperating implementations of this interface may exploit dot-separated attribute names to provide seamless access to the attributes of attribute value which also implements AttrSet interface as if it was direct attribute of the container E.g., ((AttrSet)container.get("x")).get("y") is equivalent to container.get("x.y");

Version:
$Revision$, $Date$

  • Method Details

    • isValuePresent

      boolean isValuePresent(String n)
      Checks if this argument block contains the given key.
      Parameters:
      n - key
      Returns:
      true if key is present

    • addStringValue

      Object addStringValue(String n, String v)
      Adds string-based value into this argument block.
      Parameters:
      n - key
      v - value
      Returns:
      value

    • getValueAsString

      String getValueAsString(String n) throws EBaseException
      Retrieves argument value as string.
      Parameters:
      n - key
      Returns:
      argument value as string
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsString

      String getValueAsString(String n, String def)
      Retrieves argument value as string.
      Parameters:
      n - key
      def - default value to be returned if key is not present
      Returns:
      argument value as string

    • getValueAsInt

      int getValueAsInt(String n) throws EBaseException
      Retrieves argument value as integer.
      Parameters:
      n - key
      Returns:
      argument value as int
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsInt

      int getValueAsInt(String n, int def)
      Retrieves argument value as integer.
      Parameters:
      n - key
      def - default value to be returned if key is not present
      Returns:
      argument value as int

    • getValueAsBigInteger

      BigInteger getValueAsBigInteger(String n) throws EBaseException
      Retrieves argument value as big integer.
      Parameters:
      n - key
      Returns:
      argument value as big integer
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsBigInteger

      BigInteger getValueAsBigInteger(String n, BigInteger def)
      Retrieves argument value as big integer.
      Parameters:
      n - key
      def - default value to be returned if key is not present
      Returns:
      argument value as big integer

    • getValue

      Object getValue(Object n) throws EBaseException
      Retrieves argument value as object
      Parameters:
      n - key
      Returns:
      argument value as object
      Throws:
      EBaseException - failed to retrieve value

    • getValue

      Object getValue(Object n, Object def)
      Retrieves argument value as object
      Parameters:
      n - key
      def - default value to be returned if key is not present
      Returns:
      argument value as object

    • getValueAsBoolean

      boolean getValueAsBoolean(String name) throws EBaseException
      Gets boolean value. They should be "true" or "false".
      Parameters:
      name - name of the input type
      Returns:
      boolean type: true or false
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsBoolean

      boolean getValueAsBoolean(String name, boolean def)
      Gets boolean value. They should be "true" or "false".
      Parameters:
      name - name of the input type
      def - Default value to return.
      Returns:
      boolean type: true or false

    • getValueAsKeyGenInfo

      KeyGenInfo getValueAsKeyGenInfo(String name, KeyGenInfo def) throws EBaseException
      Gets KeyGenInfo
      Parameters:
      name - name of the input type
      def - default value to return
      Returns:
      KeyGenInfo object
      Throws:
      EBaseException - On error.

    • getValueAsRawPKCS10

      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsRawPKCS10(String name) throws EBaseException
      Gets PKCS10 request. This pkcs10 attribute does not contain header information.
      Parameters:
      name - name of the input type
      Returns:
      pkcs10 request
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsRawPKCS10

      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsRawPKCS10(String name, org.mozilla.jss.netscape.security.pkcs.PKCS10 def) throws EBaseException
      Gets PKCS10 request. This pkcs10 attribute does not contain header information.
      Parameters:
      name - name of the input type
      def - default PKCS10
      Returns:
      pkcs10 request
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsPKCS10

      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsPKCS10(String name, boolean checkheader) throws EBaseException
      Retrieves PKCS10
      Parameters:
      name - name of the input type
      checkheader - true if header must be present
      Returns:
      PKCS10 object
      Throws:
      EBaseException - failed to retrieve value

    • getValueAsPKCS10

      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsPKCS10(String name, boolean checkheader, org.mozilla.jss.netscape.security.pkcs.PKCS10 def) throws EBaseException
      Retrieves PKCS10
      Parameters:
      name - name of the input type
      checkheader - true if header must be present
      def - default PKCS10
      Returns:
      PKCS10 object
      Throws:
      EBaseException - on error

    • getValuePKCS10

      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValuePKCS10(String name, org.mozilla.jss.netscape.security.pkcs.PKCS10 def) throws EBaseException
      Retrieves PKCS10
      Parameters:
      name - name of the input type
      def - default PKCS10
      Returns:
      PKCS10 object
      Throws:
      EBaseException - on error

    • elements

      Enumeration<String> elements()
      Retrieves a list of argument keys.
      Returns:
      a list of string-based keys

    • addLongValue

      Object addLongValue(String n, long v)
      Adds long-type arguments to this block.
      Parameters:
      n - key
      v - value
      Returns:
      value

    • addIntegerValue

      Object addIntegerValue(String n, int v)
      Adds integer-type arguments to this block.
      Parameters:
      n - key
      v - value
      Returns:
      value

    • addBooleanValue

      Object addBooleanValue(String n, boolean v)
      Adds boolean-type arguments to this block.
      Parameters:
      n - key
      v - value
      Returns:
      value

    • addBigIntegerValue

      Object addBigIntegerValue(String n, BigInteger v, int radix)
      Adds integer-type arguments to this block.
      Parameters:
      n - key
      v - value
      radix - radix
      Returns:
      value

    • set

      void set(String name, Object obj)
      Sets argument into this block.
      Parameters:
      name - key
      obj - value

    • get

      Object get(String name)
      Retrieves argument.
      Parameters:
      name - key
      Returns:
      object value

    • delete

      void delete(String name)
      Deletes argument by the given key.
      Parameters:
      name - key

    • getElements

      Enumeration<String> getElements()
      Retrieves a list of argument keys.
      Returns:
      a list of string-based keys