scim-spec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/ErrorMessageType.java

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
 
* http://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.apache.directory.scim.protocol;

import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;

import lombok.AccessLevel;
import lombok.Getter;

@XmlEnum(String.class)
@Getter(AccessLevel.PUBLIC)
public enum ErrorMessageType {
  
  //HTTP 400 Error messages (SCIM Protocol Specification, section 3.12, page 69)
  
  //GET (Section specified attribute and filter 3.4.2), POST (Search - Section 3.4.3), PATCH (Path Filter - Section 3.5.2)
  @XmlEnumValue("invalidFilter")
  INVALID_FILTER("invalidFilter", "The specified filter syntax was invalid, or the specified attribute and filter comparison combination is not supported."),

  //GET (Section 3.4.2), POST (Search - Section 3.4.3)
  @XmlEnumValue("tooMany")
  TOO_MANY("tooMany", "The specified filter yields many more results than the server is willing to calculate or process.  For example, a filter such as \"(userName pr)\" by itself would return all entries with a \"userName\" and MAY not be acceptable to the service provider."),
     
  //POST (Create - Section 3.3), PUT (Section 3.5.1), PATCH (Section 3.5.2)
  @XmlEnumValue("uniqueness")
  UNIQUENESS("uniqueness", "One or more of the attribute values are already in use or are reserved."),

  //PUT (Section 3.5.1), PATCH (Section 3.5.2)
  @XmlEnumValue("mutability")
  MUTABILITY("mutability", "The attempted modification is not compatible with the target attribute's mutability or current state (e.g., modification of an \"immutable\" attribute with an existing value)."),
  
  //POST (Search - Section 3.4.3, Create - Section 3.3, Bulk - Section 3.7), PUT (Section 3.5.1) 
  @XmlEnumValue("invalidSyntax")
  INVALID_SYNTAX("invalidSyntax", "The request body message structure was invalid or did not conform to the request schema."),

  //PATCH (Section 3.5.2) 
  @XmlEnumValue("invalidPath")
  INVALID_PATH("invalidPath", "The \"path\" attribute was invalid or malformed (see invalid or malformed (see Figure 7)."),

  //PATCH (Section 3.5.2)
  @XmlEnumValue("noTarget")
  NO_TARGET("noTarget", "The specified \"path\" did not yield an attribute or attribute value that could be operated on.  This occurs when the specified \"path\" value contains a filter that yields no match."),

  //GET (Section 3.4.2), POST (Create - Section 3.3, Query - Section 3.4.3), PUT (Section 3.5.1), PATCH (Section 3.5.2)
  @XmlEnumValue("invalidValue")
  INVALID_VALUE("invalidValue", "A required value was missing, or the value specified was not compatible with the operation or attribute type (see Section 2.2 of [RFC7643]), or resource schema (see Section 4 of [RFC7643])."),

  //GET (Section 3.4.2), POST (ALL), PUT (Section 3.5.1), PATCH (Section 3.5.2), DELETE (Section 3.6)
  @XmlEnumValue("invalidVers")
  INVALID_VERS("invalidVers", "The specified SCIM protocol version is not supported (see Section 3.13)."),

  //GET (Section 3.4.2)
  @XmlEnumValue("sensitive")
  SENSITIVE("sensitive", "The specified request cannot be completed, due to the passing of sensitive (e.g., personal) information in a request URI.  For example, personal information SHALL NOT be transmitted over request URIs.  See Section 7.5.2.");

  private String scimType;
  private String detail;

  ErrorMessageType(String scimType, String detail) {
    this.scimType = scimType;
    this.detail = detail;
  }
}