Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 2 (11.1.2)

E27155-01 ESAPI


oracle.security.jps.service.policystore.info
Interface AttributeEntry<T extends DataType>

Type Parameters:
T -
All Superinterfaces:
ExpressionComponent
All Known Implementing Classes:
BasicAttributeEntry

public interface AttributeEntry<T extends DataType>
extends ExpressionComponent

The class stands for attribute defined in the system. Users can create Attribute in three ways. 1. Create an in-memory attribute object and then assign the object to a principal/resource/role For example:

 AttributeEntry<OpssString> attr = new BasicAttributeEntry<OpssString>("name", new OpssString("John"));
 resouce.addAttribute(attr);
 

2. Create an attribute by ExtensionManager.createAttribute() For example:

 AttributeEntry<OpssString> attr = ExtensionManager.createAttribute("name", "display name", "description", OpssString.class, AttributeCategory.DYNAMIC, true);
 

3. Set attribute value

 AttributeEntry<OpssString> attr = ExtensionManager.createAttribute("name", "display name", "description", OpssString.class, AttributeCategory.DYNAMIC, true);
 attr.setValue(new OpssString("John"));
 

Nested Class Summary
static class AttributeEntry.AttributeCategory
          attribute category

 

Nested classes/interfaces inherited from interface oracle.security.jps.service.policystore.info.ExpressionComponent
ExpressionComponent.Type

 

Method Summary
 AttributeEntry.AttributeCategory getAttributeCategory()
          Return category of the attribute
 java.lang.Class<? extends DataType> getAttributeType()
          Return data type of the attribute
 java.lang.String getDescription()
          Get the description of the entity.
 java.lang.String getDisplayName()
          Returns the Display name.
 java.util.List<T> getMultipleValue()
          Get the value of this attribute, if the attribute contains multiple values.
 java.lang.String getName()
          Name of the entry.
 T getValue()
          Get the value of this attribute, if the attribute contains single value.
 boolean isBuiltInAttribute()
          if it is a built-in attribute, return true, else, return false
 boolean isSingleValue()
          Check the attribute supports single value or multiple value
 void setDescription(java.lang.String description)
          Set the description of this entry.
 void setDisplayName(java.lang.String displayName)
          Set the display name of this entry.
 void setMultipleValue(java.util.List<T> values)
          Set the multiple values for this attribute
 void setValue(T value)
          Set the value for this attribute

 

Methods inherited from interface oracle.security.jps.service.policystore.info.ExpressionComponent
getComponentType

 

Method Detail

isSingleValue

boolean isSingleValue()
Check the attribute supports single value or multiple value
Returns:
true if this is a single valued attribute. False otherwise.

getValue

T getValue()
                            throws PolicyStoreOperationNotAllowedException
Get the value of this attribute, if the attribute contains single value. Otherwise, use getMultipleValue()
Returns:
the value of attribute. If there is no value, return null.
Throws:
PolicyStoreOperationNotAllowedException - if the attribute contains multiple values.

getMultipleValue

java.util.List<T> getMultipleValue()
                                                    throws PolicyStoreOperationNotAllowedException
Get the value of this attribute, if the attribute contains multiple values. Otherwise, use getValue()
Returns:
a List of values. If there are no values, an empty list will be returned.
Throws:
PolicyStoreOperationNotAllowedException - if the attribute contains single value.

setValue

void setValue(T value)
              throws PolicyStoreOperationNotAllowedException
Set the value for this attribute
Parameters:
value - the attribute value
Throws:
PolicyStoreOperationNotAllowedException - if the attribute contains multiple values.

setMultipleValue

void setMultipleValue(java.util.List<T> values)
                      throws PolicyStoreOperationNotAllowedException
Set the multiple values for this attribute
Parameters:
values - A list of attribute value
Throws:
PolicyStoreOperationNotAllowedException - if the attribute contains single value.

getAttributeType

java.lang.Class<? extends DataType> getAttributeType()
Return data type of the attribute
Returns:
get data type the attribute.

getAttributeCategory

AttributeEntry.AttributeCategory getAttributeCategory()
Return category of the attribute

isBuiltInAttribute

boolean isBuiltInAttribute()
if it is a built-in attribute, return true, else, return false
Returns:
true if thi is a built in attribute. False otherwise

getDescription

java.lang.String getDescription()
Get the description of the entity.
Returns:
the description of the entity.

getDisplayName

java.lang.String getDisplayName()
Returns the Display name.
Returns:
the display name.

setDescription

void setDescription(java.lang.String description)
Set the description of this entry.
Parameters:
description -

setDisplayName

void setDisplayName(java.lang.String displayName)
Set the display name of this entry.
Parameters:
displayName -

getName

java.lang.String getName()
Name of the entry.
Returns:
the name of the entry.

Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 2 (11.1.2)

E27155-01 ESAPI


Copyright © 2011,2012, Oracle and/or its affiliates. All rights reserved.