public final class Resource extends Object
Modifier and Type | Method and Description |
---|---|
void |
description(LocalizableMessage description)
Sets the description of this resource.
|
boolean |
equals(Object o)
Returns
true if the provided parameter is a Resource having the same resource ID as this
resource. |
Resource |
excludedDefaultUserAttributes(Collection<String> attributeNames)
Specifies zero or more user attributes which will be excluded from the default user attribute mappings when
enabled using
includeAllUserAttributesByDefault(boolean) . |
Resource |
excludedDefaultUserAttributes(String... attributeNames)
Specifies zero or more user attributes which will be excluded from the default user attribute mappings when
enabled using
includeAllUserAttributesByDefault(boolean) . |
int |
hashCode() |
Resource |
includeAllUserAttributesByDefault(boolean include)
Specifies whether all LDAP user attributes should be mapped by default using the default schema based mapping
rules.
|
Resource |
isAbstract(boolean isAbstract)
Specifies whether this resource is an abstract type and therefore cannot be created.
|
Resource |
objectClass(String objectClass)
Specifies an LDAP object class which is to be associated with this resource.
|
Resource |
objectClasses(String... objectClasses)
Specifies LDAP object classes which are to be associated with this resource.
|
Resource |
property(String name,
PropertyMapper mapper)
Specifies a mapping for a property contained in this JSON resource.
|
Resource |
resourceTypeProperty(JsonPointer resourceTypeProperty)
Specifies the name of the JSON property which contains the resource's type, whose value is the
resource ID.
|
Resource |
subResource(SubResource subResource)
Specifies a parent-child relationship with another resource.
|
Resource |
subResources(SubResource... subResources)
Specifies a parent-child relationship with zero or more resources.
|
Resource |
superType(String resourceId)
Specifies the resource ID of the resource which is a super-type of this resource.
|
Resource |
supportedAction(Action action)
Registers an action which should be supported by this resource.
|
Resource |
supportedActions(Action... actions)
Registers zero or more actions which should be supported by this resource.
|
String |
toString()
Returns the resource ID of this resource.
|
public void description(LocalizableMessage description)
description
- the description of this resourcepublic String toString()
public boolean equals(Object o)
true
if the provided parameter is a Resource
having the same resource ID as this
resource.public Resource superType(String resourceId)
resourceId
- The resource ID of the resource which is a super-type of this resource, or null
if there is no
super-type.public Resource isAbstract(boolean isAbstract)
isAbstract
- true
if this resource is abstract.public Resource property(String name, PropertyMapper mapper)
name
- The name of the JSON property to be mapped.mapper
- The property mapper responsible for mapping the JSON property to LDAP attribute(s).public Resource includeAllUserAttributesByDefault(boolean include)
excludedDefaultUserAttributes(java.lang.String...)
in order to prevent
attributes with explicit mappings being mapped twice.include
- true
if all LDAP user attributes be mapped by default.public Resource excludedDefaultUserAttributes(String... attributeNames)
includeAllUserAttributesByDefault(boolean)
. Attributes which have explicit mappings should be
excluded in order to prevent duplication.attributeNames
- The list of attributes to be excluded.public Resource excludedDefaultUserAttributes(Collection<String> attributeNames)
includeAllUserAttributesByDefault(boolean)
. Attributes which have explicit mappings should be
excluded in order to prevent duplication.attributeNames
- The list of attributes to be excluded.public Resource resourceTypeProperty(JsonPointer resourceTypeProperty)
sub-resources
.resourceTypeProperty
- The name of the JSON property which contains the resource's type, or null
if this resource does
not have a resource type property or if it should be inherited from a super-type.public Resource objectClass(String objectClass)
objectClass
- An LDAP object class associated with this resource's LDAP representation.public Resource objectClasses(String... objectClasses)
objectClasses
- The LDAP object classes associated with this resource's LDAP representation.public Resource supportedAction(Action action)
action
- The action supported by this resource.public Resource supportedActions(Action... actions)
actions
- The actions supported by this resource.public Resource subResource(SubResource subResource)
subResource
- The sub-resource definition.public Resource subResources(SubResource... subResources)
subResources
- The sub-resource definitions.Copyright 2010-2022 ForgeRock AS.