Package com.highdeal.hci

Class NotAuthorizedException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.highdeal.hci.OperationFailureException
com.highdeal.hci.NotAuthorizedException
All Implemented Interfaces:
OperationResult, XMLMarshallable, Serializable
public class NotAuthorizedException extends OperationFailureException
Generic exception thrown when the SAP CC user is not allowed to request an operation for one of the following reasons:
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="notAuthorizedFault">
   <xs:complexType>
     <xs:attribute name="internalMsg" type="xs:string"/>
     <xs:attribute name="opID" type="xs:string"/>
     <xs:attribute name="message" type="xs:string"/>
     <xs:attribute name="opName" type="xs:string"/>
     <xs:attribute name="userID" type="xs:string"/>
     <xs:attribute name="reason" type="RefusualType"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="RefusualType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="operationNotAllowed"/> <!-- the user is not allowed to use the API -->
     <xs:enumeration value="catalogRestrictionViolation"/>
   </xs:restriction>
 </xs:simpleType>

  • Field Details

    • OPERATION_NOT_ALLOWED

      public static final int OPERATION_NOT_ALLOWED
      0: This constant shows that the required API operation is not allowed for the SAP CC user.
      See Also:

    • CATALOG_RESTRICTION_VIOLATION

      public static final int CATALOG_RESTRICTION_VIOLATION
      1: This constant shows that the required API operation was called on an object which does not belong to the pricing catalog associated to the SAP CC user.
      See Also:

  • Constructor Details

    • NotAuthorizedException

      public NotAuthorizedException()
      Constructs an empty exception.

    • NotAuthorizedException

      public NotAuthorizedException(String n, String id)
      Constructs an exception for an unauthorized operation.
      Parameters:
      n - The name of the unauthorized operation
      id - The ID of the unauthorized operation

    • NotAuthorizedException

      public NotAuthorizedException(int reasonCode, String opName, String id, String userID, String internalMsg)
      Constructs an exception for an unauthorized operation.
      Parameters:
      opName - The name of the unauthorized operation
      id - The ID of the unauthorized operation
      userID - The login of the SAP CC user who tries to request the operation
      internalMsg - The internal message why the authorization is rejected.

  • Method Details

    • getOpID

      public String getOpID()
      Returns the ID of the operation that has been refused.
      Returns:
      The ID of the refused operation

    • getOperationName

      public String getOperationName()
      Returns the name of the operation that has been refused.
      Returns:
      The name of the refused operation

    • getUserID

      public String getUserID()
      Returns the ID (login) of the non authorized SAP CC user.
      Returns:
      The user login

    • getReason

      public int getReason()
      Returns the reason why the SAP CC user is rejected; The possible reasons are OPERATION_NOT_ALLOWED and CATALOG_RESTRICTION_VIOLATION.
      Returns:
      The exception related reason
      See Also:

    • getInternalMsg

      public String getInternalMsg()
      Gets the text message corresponding to the server rejection.
      Returns:
      The exception related text message

    • reasonToString

      public String reasonToString()
      Transforms the reason into an XML attribute string.
      Returns:
      The readable reason

    • parseReason

      public int parseReason(String str)
      Parses the reason string into the related integer.
      Parameters:
      str - The reason code
      Returns:
      The reason constant value

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Description copied from interface: XMLMarshallable
      Sets the attributes of the XML representation of the element being processed.
      Parameters:
      atts - The XML attributes of the current element

    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Parameters:
      cData - The character data to be added

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Description copied from interface: XMLMarshallable
      Adds a child to the object, the child representing the marshallable object which must be added to the element.
      Parameters:
      tagName - The name of tag for the child
      child - The child to be added

    • marshal

      public void marshal(XMLOutputter output)
      Description copied from interface: XMLMarshallable
      Gives an XML representation of this object, including its children.
      Parameters:
      output - The XML output to marshal the object into

    • getOperandReference

      public String getOperandReference()
      Description copied from interface: OperationResult
      Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
      Specified by:
      getOperandReference in interface OperationResult
      Overrides:
      getOperandReference in class OperationFailureException
      Returns:
      The operand reference of the operation result

    • getMessage

      public String getMessage()
      Overrides:
      getMessage in class Throwable