Class AttributeNames.Custom
- java.lang.Object
-
- de.captaingoldfish.scim.sdk.common.constants.AttributeNames.Custom
-
- Enclosing class:
- AttributeNames
public static class AttributeNames.Custom extends Object
this class holds all additional custom attributes defined by this implementation
-
-
Field Summary
Fields Modifier and Type Field Description static StringACTIVATE_SAILS_POINT_WORKAROUNDA Workaround to handle patch replace-ops on single complex types as add operations.static StringAUTHENTICATEDused in resource type definitions to tell us if access to a specific endpoint requires authentication or notstatic StringAUTHORIZATIONthe attribute that contains the authorization rules for a resource typestatic StringAUTO_FILTERINGthe attribute key for enabling automatic filtering on a specific resourcestatic StringAUTO_SORTINGthe attribute key for enabling automatic sorting on a specific resourcestatic StringCHILDRENa field used inBulkResponseGetOperations to identify the children of a resourcestatic StringDENY_RETURN_RESOURCES_ON_BULKa field for the service provider configuration.static StringDISABLE_CREATEthis attribute will disable the create endpointstatic StringDISABLE_DELETEthis attribute will disable the delete endpointstatic StringDISABLE_GETthis attribute will disable the get-endpointstatic StringDISABLE_LISTthis attribute will disable get list-endpointstatic StringDISABLE_UPDATEthis attribute will disable the update endpointstatic StringENDPOINT_CONTROLan extension attribute for resource type control that allows to disable certain endpoints for a resource typestatic StringERROR_MESSAGESused in error responses to display the list of messages that have been added to the requests validation error context that could not be directly issued to a resource fieldstatic StringERRORSused as a key for a wrapper node in error responses.static StringETAG_ENABLEDa boolean if set to false ETags will not be generated automatically on this resource endpoint.static StringFIELD_ERRORSused in error responses to display a map of messages that are bound to specific resource fieldsstatic StringMAX_ITEMSthis attribute defines the validation attribute for array types "maxItems"static StringMAX_LENGTHthis attribute defines the validation attribute for string types "maxLength"static StringMAX_RESOURCE_LEVELa field used in bulk-requests to utilize the bulk-get feature that is not defined within the SCIM specification.static StringMAXIMUMthis attribute defines the validation attribute for integer types "maximum"static StringMIN_ITEMSthis attribute defines the validation attribute for array types "minItems"static StringMIN_LENGTHthis attribute defines the validation attribute for string types "minLength"static StringMINIMUMthis attribute defines the validation attribute for integer types "minimum"static StringMULTIPLE_OFthis attribute defines the validation attribute for integers types "multipleOf"static StringNODE_PATHa field used inBulkResponseGetOperations to point to the parents node that is referencing the retrieved resource.static StringNOT_AFTERthis attribute defines the validation attribute for dateTime types 'notAfter'static StringNOT_BEFOREthis attribute defines the validation attribute for dateTime types 'notBefore'static StringPATTERNthis attribute defines the validation attribute for string types "pattern"static StringRESOURCEa field used inBulkResponseGetOperations to identify the returned resourcestatic StringRESOURCE_IDa field used inBulkResponseGetOperations to identify the referenced resource.static StringRESOURCE_TYPE_DISABLEDthis attribute tells us if a resource type was disabledstatic StringRESOURCE_TYPE_REFERENCE_NAMEa field for theSchemaAttributeclass.
Only usable in combination with 'type=reference' and 'resourceTypes=['resource']'.static StringRETURN_RESOURCEa field for bulk-requests that allow clients to explicitly ask for the resource that was created or modified to be returned.static StringRETURN_RESOURCES_BY_DEFAULT_ON_BULKa configuration field for the service provider object in theBulkConfigthat allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly ask for them.static StringRETURN_RESOURCES_ENABLEDa configuration field for the service provider object in theBulkConfigthat allows resources to be returned from the bulk endpoint.static StringROLESthis attribute defines the role-array for resource typesstatic StringROLES_CREATEthis attribute defines the role-array for the create endpoint of a specific resource typestatic StringROLES_DELETEthis attribute defines the role-array for the delete endpoint of a specific resource typestatic StringROLES_GETthis attribute defines the role-array for the get endpoint of a specific resource typestatic StringROLES_UPDATEthis attribute defines the role-array for the update endpoint of a specific resource typestatic StringSINGLETON_ENDPOINTan attribute key for ResourceTypes to setup a resource endpoint as singleton endpointstatic StringSUPPORT_BULK_GETa field for the service provider configuration.
-
Constructor Summary
Constructors Constructor Description Custom()
-
-
-
Field Detail
-
SINGLETON_ENDPOINT
public static final String SINGLETON_ENDPOINT
an attribute key for ResourceTypes to setup a resource endpoint as singleton endpoint- See Also:
- Constant Field Values
-
AUTO_FILTERING
public static final String AUTO_FILTERING
the attribute key for enabling automatic filtering on a specific resource- See Also:
- Constant Field Values
-
AUTO_SORTING
public static final String AUTO_SORTING
the attribute key for enabling automatic sorting on a specific resource- See Also:
- Constant Field Values
-
RESOURCE_TYPE_DISABLED
public static final String RESOURCE_TYPE_DISABLED
this attribute tells us if a resource type was disabled- See Also:
- Constant Field Values
-
ENDPOINT_CONTROL
public static final String ENDPOINT_CONTROL
an extension attribute for resource type control that allows to disable certain endpoints for a resource type- See Also:
- Constant Field Values
-
DISABLE_CREATE
public static final String DISABLE_CREATE
this attribute will disable the create endpoint- See Also:
- Constant Field Values
-
DISABLE_GET
public static final String DISABLE_GET
this attribute will disable the get-endpoint- See Also:
- Constant Field Values
-
DISABLE_LIST
public static final String DISABLE_LIST
this attribute will disable get list-endpoint- See Also:
- Constant Field Values
-
DISABLE_UPDATE
public static final String DISABLE_UPDATE
this attribute will disable the update endpoint- See Also:
- Constant Field Values
-
DISABLE_DELETE
public static final String DISABLE_DELETE
this attribute will disable the delete endpoint- See Also:
- Constant Field Values
-
AUTHORIZATION
public static final String AUTHORIZATION
the attribute that contains the authorization rules for a resource type- See Also:
- Constant Field Values
-
ROLES
public static final String ROLES
this attribute defines the role-array for resource types- See Also:
- Constant Field Values
-
ROLES_CREATE
public static final String ROLES_CREATE
this attribute defines the role-array for the create endpoint of a specific resource type- See Also:
- Constant Field Values
-
ROLES_GET
public static final String ROLES_GET
this attribute defines the role-array for the get endpoint of a specific resource type- See Also:
- Constant Field Values
-
ROLES_UPDATE
public static final String ROLES_UPDATE
this attribute defines the role-array for the update endpoint of a specific resource type- See Also:
- Constant Field Values
-
ROLES_DELETE
public static final String ROLES_DELETE
this attribute defines the role-array for the delete endpoint of a specific resource type- See Also:
- Constant Field Values
-
MULTIPLE_OF
public static final String MULTIPLE_OF
this attribute defines the validation attribute for integers types "multipleOf"- See Also:
- Constant Field Values
-
MINIMUM
public static final String MINIMUM
this attribute defines the validation attribute for integer types "minimum"- See Also:
- Constant Field Values
-
MAXIMUM
public static final String MAXIMUM
this attribute defines the validation attribute for integer types "maximum"- See Also:
- Constant Field Values
-
MAX_LENGTH
public static final String MAX_LENGTH
this attribute defines the validation attribute for string types "maxLength"- See Also:
- Constant Field Values
-
MIN_LENGTH
public static final String MIN_LENGTH
this attribute defines the validation attribute for string types "minLength"- See Also:
- Constant Field Values
-
PATTERN
public static final String PATTERN
this attribute defines the validation attribute for string types "pattern"- See Also:
- Constant Field Values
-
MIN_ITEMS
public static final String MIN_ITEMS
this attribute defines the validation attribute for array types "minItems"- See Also:
- Constant Field Values
-
MAX_ITEMS
public static final String MAX_ITEMS
this attribute defines the validation attribute for array types "maxItems"- See Also:
- Constant Field Values
-
NOT_BEFORE
public static final String NOT_BEFORE
this attribute defines the validation attribute for dateTime types 'notBefore'- See Also:
- Constant Field Values
-
NOT_AFTER
public static final String NOT_AFTER
this attribute defines the validation attribute for dateTime types 'notAfter'- See Also:
- Constant Field Values
-
ETAG_ENABLED
public static final String ETAG_ENABLED
a boolean if set to false ETags will not be generated automatically on this resource endpoint. Default is true.- See Also:
- Constant Field Values
-
AUTHENTICATED
public static final String AUTHENTICATED
used in resource type definitions to tell us if access to a specific endpoint requires authentication or not- See Also:
- Constant Field Values
-
ERROR_MESSAGES
public static final String ERROR_MESSAGES
used in error responses to display the list of messages that have been added to the requests validation error context that could not be directly issued to a resource field- See Also:
- Constant Field Values
-
FIELD_ERRORS
public static final String FIELD_ERRORS
used in error responses to display a map of messages that are bound to specific resource fields- See Also:
- Constant Field Values
-
ERRORS
public static final String ERRORS
used as a key for a wrapper node in error responses. This wrapper object node will optionally hold the keysERROR_MESSAGESorFIELD_ERRORSor both- See Also:
- Constant Field Values
-
RETURN_RESOURCE
public static final String RETURN_RESOURCE
a field for bulk-requests that allow clients to explicitly ask for the resource that was created or modified to be returned.- See Also:
- Constant Field Values
-
RETURN_RESOURCES_ENABLED
public static final String RETURN_RESOURCES_ENABLED
a configuration field for the service provider object in theBulkConfigthat allows resources to be returned from the bulk endpoint.- See Also:
- Constant Field Values
-
RETURN_RESOURCES_BY_DEFAULT_ON_BULK
public static final String RETURN_RESOURCES_BY_DEFAULT_ON_BULK
a configuration field for the service provider object in theBulkConfigthat allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly ask for them. The client will still be capable to ask the service provider to not return the resource.- See Also:
- Constant Field Values
-
DENY_RETURN_RESOURCES_ON_BULK
public static final String DENY_RETURN_RESOURCES_ON_BULK
a field for the service provider configuration. If set to true the service provider will not return resources from the explicit resource-type if the client asks for them in the request.- See Also:
- Constant Field Values
-
SUPPORT_BULK_GET
public static final String SUPPORT_BULK_GET
a field for the service provider configuration. If set to true the bulk endpoint will have a new feature enabled that allows to get a single resource and all its relations within a bulk response- See Also:
- Constant Field Values
-
RESOURCE_TYPE_REFERENCE_NAME
public static final String RESOURCE_TYPE_REFERENCE_NAME
a field for theSchemaAttributeclass.
Only usable in combination with 'type=reference' and 'resourceTypes=['resource']'. It will bind the attribute to the ID of a specific resource. The value must match the name of a registered 'resourceType' not a 'resource'-name! In case of the /Me endpoint use the value 'Me' not the value 'User'- See Also:
- Constant Field Values
-
MAX_RESOURCE_LEVEL
public static final String MAX_RESOURCE_LEVEL
a field used in bulk-requests to utilize the bulk-get feature that is not defined within the SCIM specification. It allows to set the maximum transitive level of resources to be extracted within a bulk-get-request- See Also:
- Constant Field Values
-
NODE_PATH
public static final String NODE_PATH
a field used inBulkResponseGetOperations to point to the parents node that is referencing the retrieved resource.- See Also:
- Constant Field Values
-
RESOURCE
public static final String RESOURCE
a field used inBulkResponseGetOperations to identify the returned resource- See Also:
- Constant Field Values
-
CHILDREN
public static final String CHILDREN
a field used inBulkResponseGetOperations to identify the children of a resource- See Also:
- Constant Field Values
-
RESOURCE_ID
public static final String RESOURCE_ID
a field used inBulkResponseGetOperations to identify the referenced resource. This is especially useful if retrieval of the resource has failed in order to link the response operation to the resource that could not be extracted- See Also:
- Constant Field Values
-
ACTIVATE_SAILS_POINT_WORKAROUND
public static final String ACTIVATE_SAILS_POINT_WORKAROUND
A Workaround to handle patch replace-ops on single complex types as add operations.- See Also:
- Constant Field Values
-
-