public abstract class AbstractAccessReferenceMap<K> extends Object implements AccessReferenceMap<K>
public MyClassUsingAARM {
private AbstractAccessReferenceMap| Modifier and Type | Field and Description |
|---|---|
protected Map<Object,K> |
dtoi
The Direct to Indirect Map
|
protected Map<K,Object> |
itod
The Indirect to Direct Map
|
| Constructor and Description |
|---|
AbstractAccessReferenceMap()
Instantiates a new access reference map.
|
AbstractAccessReferenceMap(int initialSize)
Instantiates a new access reference map with the specified size allotment
to reduce Map resizing overhead.
|
AbstractAccessReferenceMap(Set<Object> directReferences)
Deprecated.
This constructor internally calls the abstract method
getUniqueReference(). Since this is a constructor, any
subclass that implements getUniqueReference() has not had it's
own constructor run. This leads to strange bugs because subclass
internal state is initializaed after calls to getUniqueReference()
have already happened. If this constructor is desired in a
subclass, consider running update(Set) in the subclass
constructor instead. |
AbstractAccessReferenceMap(Set<Object> directReferences,
int initialSize)
Deprecated.
This constructor internally calls the abstract method
getUniqueReference(). Since this is a constructor, any
subclass that implements getUniqueReference() has not had it's
own constructor run. This leads to strange bugs because subclass
internal state is initializaed after calls to getUniqueReference()
have already happened. If this constructor is desired in a
subclass, consider running update(Set) in the subclass
constructor instead. |
| Modifier and Type | Method and Description |
|---|---|
<T> K |
addDirectReference(T direct)
Adds a direct reference to the AccessReferenceMap, then generates and returns
an associated indirect reference.
|
<T> T |
getDirectReference(K indirectReference)
Get the original direct object reference from an indirect reference.
|
<T> K |
getIndirectReference(T directReference)
Get a safe indirect reference to use in place of a potentially sensitive
direct object reference.
|
protected abstract K |
getUniqueReference()
Returns a Unique Reference Key to be associated with a new directReference being
inserted into the AccessReferenceMap.
|
Iterator |
iterator()
Get an iterator through the direct object references.
|
<T> K |
removeDirectReference(T direct)
Removes a direct reference and its associated indirect reference from the AccessReferenceMap.
|
void |
update(Set directReferences)
Updates the access reference map with a new set of direct references, maintaining
any existing indirect references associated with items that are in the new list.
|
public AbstractAccessReferenceMap()
HashMap.DEFAULT_INITIAL_CAPACITY and that resizing a Map is an expensive process. Consider
using a constructor where the initialSize is passed in to maximize performance of the AccessReferenceMap.public AbstractAccessReferenceMap(int initialSize)
initialSize - The initial size of the underlying maps@Deprecated public AbstractAccessReferenceMap(Set<Object> directReferences)
getUniqueReference(). Since this is a constructor, any
subclass that implements getUniqueReference() has not had it's
own constructor run. This leads to strange bugs because subclass
internal state is initializaed after calls to getUniqueReference()
have already happened. If this constructor is desired in a
subclass, consider running update(Set) in the subclass
constructor instead.directReferences - the direct references@Deprecated public AbstractAccessReferenceMap(Set<Object> directReferences, int initialSize)
getUniqueReference(). Since this is a constructor, any
subclass that implements getUniqueReference() has not had it's
own constructor run. This leads to strange bugs because subclass
internal state is initializaed after calls to getUniqueReference()
have already happened. If this constructor is desired in a
subclass, consider running update(Set) in the subclass
constructor instead.directReferences - The references to initialize the access reference mapinitialSize - The initial size to set the map to.protected abstract K getUniqueReference()
public Iterator iterator()
iterator in interface AccessReferenceMap<K>public <T> K addDirectReference(T direct)
addDirectReference in interface AccessReferenceMap<K>direct - the direct referencepublic <T> K removeDirectReference(T direct) throws AccessControlException
removeDirectReference in interface AccessReferenceMap<K>direct - the direct reference to removeAccessControlException - if the reference does not exist.public final void update(Set directReferences)
update in interface AccessReferenceMap<K>directReferences - a Set of direct references to addpublic <T> K getIndirectReference(T directReference)
getIndirectReference in interface AccessReferenceMap<K>directReference - the direct referencepublic <T> T getDirectReference(K indirectReference) throws AccessControlException
UserProfile profile = arm.getDirectReference( indirectRef );Will throw a AccessControlException if the object stored in memory is not of type UserProfile. However,
Object uncastObject = arm.getDirectReference( indirectRef );Will never throw a AccessControlException as long as the object exists. If you are unsure of the object type of that an indirect reference references you should get the uncast object and test for type in the calling code.
Object uncastProfile = arm.getDirectReference( indirectRef );
if ( uncastProfile instanceof UserProfile ) {
UserProfile userProfile = (UserProfile) uncastProfile;
// ...
} else {
EmployeeProfile employeeProfile = (EmployeeProfile) uncastProfile;
// ...
}
getDirectReference in interface AccessReferenceMap<K>indirectReference - the indirect referenceAccessControlException - if no direct reference exists for the specified indirect referenceCopyright © 2022 The Open Web Application Security Project (OWASP). All rights reserved.