Package de.captaingoldfish.scim.sdk.common.constants

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 Details

    • SINGLETON_ENDPOINT

      public static final String SINGLETON_ENDPOINT
      an attribute key for ResourceTypes to setup a resource endpoint as singleton endpoint
      See Also:

    • AUTO_FILTERING

      public static final String AUTO_FILTERING
      the attribute key for enabling automatic filtering on a specific resource
      See Also:

    • AUTO_SORTING

      public static final String AUTO_SORTING
      the attribute key for enabling automatic sorting on a specific resource
      See Also:

    • RESOURCE_TYPE_DISABLED

      public static final String RESOURCE_TYPE_DISABLED
      this attribute tells us if a resource type was disabled
      See Also:

    • 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:

    • DISABLE_CREATE

      public static final String DISABLE_CREATE
      this attribute will disable the create endpoint
      See Also:

    • DISABLE_GET

      public static final String DISABLE_GET
      this attribute will disable the get-endpoint
      See Also:

    • DISABLE_LIST

      public static final String DISABLE_LIST
      this attribute will disable get list-endpoint
      See Also:

    • DISABLE_UPDATE

      public static final String DISABLE_UPDATE
      this attribute will disable the update endpoint
      See Also:

    • DISABLE_DELETE

      public static final String DISABLE_DELETE
      this attribute will disable the delete endpoint
      See Also:

    • AUTHORIZATION

      public static final String AUTHORIZATION
      the attribute that contains the authorization rules for a resource type
      See Also:

    • ROLES

      public static final String ROLES
      this attribute defines the role-array for resource types
      See Also:

    • USE_OR_ON_ROLES

      public static final String USE_OR_ON_ROLES
      tells us if the roles entered within the arrays must all be present for the user to access the endpoint or if only a single role is necessary. Default is false
      See Also:

    • 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:

    • 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:

    • ROLES_LIST

      public static final String ROLES_LIST
      this attribute defines the role-array for the list endpoint of a specific resource type
      See Also:

    • 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:

    • 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:

    • MULTIPLE_OF

      public static final String MULTIPLE_OF
      this attribute defines the validation attribute for integers types "multipleOf"
      See Also:

    • MINIMUM

      public static final String MINIMUM
      this attribute defines the validation attribute for integer types "minimum"
      See Also:

    • MAXIMUM

      public static final String MAXIMUM
      this attribute defines the validation attribute for integer types "maximum"
      See Also:

    • MAX_LENGTH

      public static final String MAX_LENGTH
      this attribute defines the validation attribute for string types "maxLength"
      See Also:

    • MIN_LENGTH

      public static final String MIN_LENGTH
      this attribute defines the validation attribute for string types "minLength"
      See Also:

    • PATTERN

      public static final String PATTERN
      this attribute defines the validation attribute for string types "pattern"
      See Also:

    • MIN_ITEMS

      public static final String MIN_ITEMS
      this attribute defines the validation attribute for array types "minItems"
      See Also:

    • MAX_ITEMS

      public static final String MAX_ITEMS
      this attribute defines the validation attribute for array types "maxItems"
      See Also:

    • NOT_BEFORE

      public static final String NOT_BEFORE
      this attribute defines the validation attribute for dateTime types 'notBefore'
      See Also:

    • NOT_AFTER

      public static final String NOT_AFTER
      this attribute defines the validation attribute for dateTime types 'notAfter'
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 keys ERROR_MESSAGES or FIELD_ERRORS or both
      See Also:

    • 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:

    • RETURN_RESOURCES_ENABLED

      public static final String RETURN_RESOURCES_ENABLED
      a configuration field for the service provider object in the BulkConfig that allows resources to be returned from the bulk endpoint.
      See Also:

    • 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 the BulkConfig that 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:

    • 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:

    • 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:

    • RESOURCE_TYPE_REFERENCE_NAME

      public static final String RESOURCE_TYPE_REFERENCE_NAME
      a field for the SchemaAttribute class.

      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:

    • 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:

    • NODE_PATH

      public static final String NODE_PATH
      a field used in BulkResponseGetOperations to point to the parents node that is referencing the retrieved resource.
      See Also:

    • RESOURCE

      public static final String RESOURCE
      a field used in BulkResponseGetOperations to identify the returned resource
      See Also:

    • CHILDREN

      public static final String CHILDREN
      a field used in BulkResponseGetOperations to identify the children of a resource
      See Also:

    • RESOURCE_ID

      public static final String RESOURCE_ID
      a field used in BulkResponseGetOperations 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:

    • IGNORE_UNKNOWN_ATTRIBUTES

      public static final String IGNORE_UNKNOWN_ATTRIBUTES
      Can be used to change the behaviour in patch-requests. If activated the patch-operation will no longer throw a BadRequestException if the referenced attribute does not exist. Instead, the operation will be ignored.
      See Also:

    • DO_NOT_FAIL_ON_NO_TARGET

      public static final String DO_NOT_FAIL_ON_NO_TARGET
      prevents that a patch-operation fails if the target of the attributes pointer is missing. In this case the operation is simply ignored.
      See Also:

    • 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:

    • ACTIVATE_MS_AZURE_FILTER_WORKAROUND

      public static final String ACTIVATE_MS_AZURE_FILTER_WORKAROUND
      A workaround to handle filter-expressions in patch-paths as attributes that will be added to the resource
      See Also:

    • ACTIVATE_MS_AZURE_VALUE_SUB_ATTRIBUTE_WORKAROUND

      public static final String ACTIVATE_MS_AZURE_VALUE_SUB_ATTRIBUTE_WORKAROUND
      A workaround indicator to handle MsAzures illegal value-subattribute notation. There might be cases in which this switch will cause with normal execution. That is why this must be activated explicitly.
      See Also:

    • ACTIVATE_MS_AZURE_COMPLEX_SIMPLE_VALUE_WORKAROUND

      public static final String ACTIVATE_MS_AZURE_COMPLEX_SIMPLE_VALUE_WORKAROUND
      A workaround indicator to handle MsAzures illegal patch-values on complex-attributes with simple values.
      See Also:

    • SERVICE_PROVIDER

      public static final String SERVICE_PROVIDER
      this attribute is used for meta-configuration loading. It will hold the ServiceProvider configuration from the SCIM provider
      See Also:

    • RESOURCE_TYPES

      public static final String RESOURCE_TYPES
      this attribute is used for meta-configuration loading. It will hold the ResourceTypes from the SCIM provider
      See Also:

    • DEFAULT_VALUE

      public static final String DEFAULT_VALUE
      Used in SchemaAttribute to assign default values to if the attribute is left empty
      See Also:

  • Constructor Details

    • Custom

      public Custom()