Oracle Entitlements Server Provider SSPI API Reference

com.bea.security.spi
Interface NameValueType


public interface NameValueType

This class represents a field within a named object. This field contains a name, value, and type. By stringing these fields together, you can construct a unique name.

Author:
Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Field Summary
static int MULTI_TOKEN
          MULTI_TOKEN is a single name/multi value pair that is included in a name.This attribute represents any leftover fields within a name after prefix attributes, terminal attributes, and single attributes are determined.
static int MULTI_VALUE_PREFIX
          MULTI_VALUE_PREFIX is a single name/muliple value pair that is included in the first part of a name.
static int MULTI_VALUE_TERMINAL
          MULTI_VALUE_TERMINAL is a single name/multiple value pair that is included in the last part of a name.
static int SINGLE_VALUE
          SINGLE_VALUE is a single name/value pair that is included in a name.
static int SINGLE_VALUE_PREFIX
          SINGLE_VALUE_PREFIX is a single name/value pair that is included in the first part of a name.
static int SINGLE_VALUE_TERMINAL
          SINGLE_VALUE_TERMINAL is a single name/value pair that is included in the last part of a name.
 
Method Summary
 java.lang.String getAuthorityName()
          Gets the name of the authority that defines this field.
 java.lang.String getName()
          Gets the name for this named value.
 int getType()
          Gets the field type of this value.
 java.lang.String getValue()
          Gets the value.
 

Field Detail

SINGLE_VALUE_PREFIX

public static final int SINGLE_VALUE_PREFIX
SINGLE_VALUE_PREFIX is a single name/value pair that is included in the first part of a name. Prefix attributes MUST be the first types of attributes within the name, but there may be more than one of them (single or multi value).

MULTI_VALUE_PREFIX

public static final int MULTI_VALUE_PREFIX
MULTI_VALUE_PREFIX is a single name/muliple value pair that is included in the first part of a name. Prefix attributes MUST be the first types of attributes within the name, but there may be more than one of them (single or multi value). Multi value attributes also define an optional authority for how the values within it are structured and parsed.

SINGLE_VALUE_TERMINAL

public static final int SINGLE_VALUE_TERMINAL
SINGLE_VALUE_TERMINAL is a single name/value pair that is included in the last part of a name. Terminal attributes MUST be the last attributes within a name, but there may be more than one of them (single or multi value).

MULTI_VALUE_TERMINAL

public static final int MULTI_VALUE_TERMINAL
MULTI_VALUE_TERMINAL is a single name/multiple value pair that is included in the last part of a name. Terminal attributes MUST be the last attributes within a name, but there may be more than one of them (single or multi value). Multi value attributes also define an optional authority for how the values within it are structured and parsed.

SINGLE_VALUE

public static final int SINGLE_VALUE
SINGLE_VALUE is a single name/value pair that is included in a name. This attribute represents a single field within a name and is determined by place value after prefix attributes and terminal attributes are determined.

MULTI_TOKEN

public static final int MULTI_TOKEN
MULTI_TOKEN is a single name/multi value pair that is included in a name.This attribute represents any leftover fields within a name after prefix attributes, terminal attributes, and single attributes are determined. There can be only ONE multitoken attribute within a name.
Method Detail

getName

public java.lang.String getName()
Gets the name for this named value.

Returns:
a name for this value as a String.

getValue

public java.lang.String getValue()
Gets the value.

Returns:
the value as a String.

getType

public int getType()
Gets the field type of this value.

Returns:
the field type of this value as an int. One of SINGLE_VALUE_PREFIX, MULTI_VALUE_PREFIX, SINGLE_VALUE, MULTI_TOKEN, SINGLE_VALUE_TERMINAL, or MULTI_VALUE_TERMINAL

getAuthorityName

public java.lang.String getAuthorityName()
Gets the name of the authority that defines this field.

Returns:
the name of the authority that defines this field as a String, or null if one does not exist.