oracle.security.jps.service.attribute

Interface AttributeService

All Superinterfaces:

JpsPersistable, OpssServiceInstance, ServiceInstance

public interface AttributeService
extends OpssServiceInstance

Attribute service provides a generic service used to store and retrieve security attributes.

Attribute keys will be used to perform operations to attributes, and will be unique within a JVM in attribute service.

Each key can be associated with at most one attribute.

Methods are protected by AttributeAccessPermission.

Methods are thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.opss.service.OpssServiceInstance

OpssServiceInstance.State

Nested classes/interfaces inherited from interface oracle.security.jps.service.JpsPersistable

JpsPersistable.Mode

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String key) Returns the attribute associated with the specified key.
void	removeAttribute(java.lang.String key) Removes the attribute object associated with the key.
void	setAttribute(java.lang.String key, java.lang.Object attribute) Sets the attribute given the specified key.

Methods inherited from interface oracle.security.opss.service.OpssServiceInstance

getState

Methods inherited from interface oracle.security.jps.service.ServiceInstance

accept, getName, getServiceProvider

Methods inherited from interface oracle.security.jps.service.JpsPersistable

persist, refresh

Method Detail

setAttribute

void setAttribute(java.lang.String key,
                java.lang.Object attribute)
                  throws AttributeServiceException,
                         java.security.AccessControlException

Sets the attribute given the specified key.

If the attribute passed in is null, the effect is the same as calling AttributeService.removeAttribute(String key).

If the attribute doesn't exists, it is added. Otherwise, the old attribute is updated.

oracle.security.jps.service.attribute.AttributeAccessPermission is required.

Parameters:

key - the key whose associated attribute is to be added or updated

attribute - the attribute to be associated with the specified key

Throws:

AttributeServiceException

java.security.AccessControlException - thrown if a requested access to attribute was denied

getAttribute

java.lang.Object getAttribute(java.lang.String key)
                              throws AttributeServiceException,
                                     java.security.AccessControlException

Returns the attribute associated with the specified key.

If the attribute doesn't exists, return null.

oracle.security.jps.service.attribute.AttributeAccessPermission is required.

Parameters:

key - the key whose associated attribute is to be returned

Returns:

attribute the attribute to which the specified key is associating, or null if the attribute doesn't exists

Throws:

AttributeServiceException

java.security.AccessControlException - thrown if a requested access to attribute was denied

removeAttribute

void removeAttribute(java.lang.String key)
                     throws AttributeServiceException,
                            java.security.AccessControlException

Removes the attribute object associated with the key.

If the attribute doesn't exists, nothing happens.

oracle.security.jps.service.attribute.AttributeAccessPermission is required.

Parameters:

key - the key whose associated attribute is to be removed

Throws:

AttributeServiceException

java.security.AccessControlException - thrown if a requested access to attribute was denied