j4cups.protocol

Enum StatusCode

java.lang.Object

java.lang.Enum<StatusCode>

j4cups.protocol.StatusCode

All Implemented Interfaces:

Serializable, Comparable<StatusCode>

public enum StatusCode
extends Enum<StatusCode>

The status-code values range from 0x0000 to 0x7fff. The value ranges for each status-code class are as follows (see RFC-8011 Appendix B):

• "successful" - 0x0000 to 0x00ff
• "informational" - 0x0100 to 0x01ff
• "redirection" - 0x0300 to 0x03ff
• client-error" - 0x0400 to 0x04ff
• server-error" - 0x0500 to 0x05ff

The top half (128 values) of each range (0x0n80 to 0x0nff, for n = 0 to 5) is reserved for vendor use within each status-code class. Values 0x0600 to 0x7fff are reserved for future assignment by Standards Track documents and MUST NOT be used.

Since:

0.2 (14.02.2018)

Author:

oboehm

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_ERROR_BAD_REQUEST The request could not be understood by the IPP object due to malformed syntax (such as the value of a fixed-length attribute whose length does not match the prescribed length for that attribute -- see the Implementor's Guides [RFC3196] [PWG5100.19]).
CLIENT_ERROR_FORBIDDEN The IPP object understood the request but is refusing to fulfill it.
CLIENT_ERROR_NOT_AUTHENTICATED The request requires user authentication.
CLIENT_ERROR_NOT_AUTHORIZED The requester is not authorized to perform the request.
CLIENT_ERROR_NOT_POSSIBLE This status-code is used when the request is for something that cannot happen.
SERVER_ERROR_MULTIPLE_DOCUMENT_JOBS_NOT_SUPPORTED The IPP object does not support multiple Documents per Job, and a Client attempted to supply Document data with a second Send-Document or Send-URI operation.
SUCCESSFUL_OK The request has succeeded, and no request attributes were substituted or ignored.
SUCCESSFUL_OK_CONFLICTING_ATTRIBUTES The request has succeeded, but some supplied attribute values conflicted with the values of other supplied attributes.
SUCCESSFUL_OK_IGNORED_OR_SUBSTITUTED_ATTRIBUTES The request has succeeded, but some supplied (1) attributes were ignored or (2) unsupported values were substituted with supported values or were ignored in order to perform the operation without rejecting it.

Method Summary

Modifier and Type	Method and Description
short	getCode() Gets the value of the statuscode.
static StatusCode	of(int id) Allows you to map a value to the corresponding statuscode
static StatusCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatusCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESSFUL_OK

public static final StatusCode SUCCESSFUL_OK

The request has succeeded, and no request attributes were substituted or ignored. In the case of a response to a Job Creation request, the 'successful-ok' status-code indicates that the request was successfully received and validated, and that the Job object has been created; it does not indicate that the Job has been processed. The transition of the Job object into the 'completed' state is the only indicator that the Job has been printed.

SUCCESSFUL_OK_IGNORED_OR_SUBSTITUTED_ATTRIBUTES

public static final StatusCode SUCCESSFUL_OK_IGNORED_OR_SUBSTITUTED_ATTRIBUTES

The request has succeeded, but some supplied (1) attributes were ignored or (2) unsupported values were substituted with supported values or were ignored in order to perform the operation without rejecting it. Unsupported attributes, attribute syntaxes, or values MUST be returned in the Unsupported Attributes group of the response for all operations. There is an exception to this rule for the query operations Get-Printer-Attributes, Get-Jobs, and Get-Job-Attributes for the "requested-attributes" operation attribute only. When the supplied values of the "requested-attributes" operation attribute are requesting attributes that are not supported, the IPP object SHOULD return the "requested-attributes" operation attribute in the Unsupported Attributes group of the response (with the unsupported values only).

SUCCESSFUL_OK_CONFLICTING_ATTRIBUTES

public static final StatusCode SUCCESSFUL_OK_CONFLICTING_ATTRIBUTES

The request has succeeded, but some supplied attribute values conflicted with the values of other supplied attributes. Either (1) these conflicting values were substituted with (supported) values or (2) the attributes were removed in order to process the Job without rejecting it. Attributes or values that conflict with other attributes and have been substituted or ignored MUST be returned in the Unsupported Attributes group of the response for all operations as supplied by the Client.

CLIENT_ERROR_BAD_REQUEST

public static final StatusCode CLIENT_ERROR_BAD_REQUEST

The request could not be understood by the IPP object due to malformed syntax (such as the value of a fixed-length attribute whose length does not match the prescribed length for that attribute -- see the Implementor's Guides [RFC3196] [PWG5100.19]). The IPP application SHOULD NOT repeat the request without modifications.

CLIENT_ERROR_FORBIDDEN

public static final StatusCode CLIENT_ERROR_FORBIDDEN

The IPP object understood the request but is refusing to fulfill it. Additional authentication information or authorization credentials will not help, and the request SHOULD NOT be repeated. This status-code is commonly used when the IPP object does not wish to reveal exactly why the request has been refused or when no other response is applicable.

CLIENT_ERROR_NOT_AUTHENTICATED

public static final StatusCode CLIENT_ERROR_NOT_AUTHENTICATED

The request requires user authentication. The IPP Client can repeat the request with suitable authentication information. If the request already included authentication information, then this status-code indicates that authorization has been refused for those credentials. If this response contains the same challenge as the prior response and the user agent has already attempted authentication at least once, then the response message can contain relevant diagnostic information. This status-code reveals more information than 'client-error-forbidden'.

CLIENT_ERROR_NOT_AUTHORIZED

public static final StatusCode CLIENT_ERROR_NOT_AUTHORIZED

The requester is not authorized to perform the request. Additional authentication information or authorization credentials will not help, and the request SHOULD NOT be repeated. This status-code is used when the IPP object wishes to reveal that the authentication information is understandable; however, the requester is explicitly not authorized to perform the request. This status-code reveals more information than 'client-error-forbidden' and 'client-error-not-authenticated'.

CLIENT_ERROR_NOT_POSSIBLE

public static final StatusCode CLIENT_ERROR_NOT_POSSIBLE

This status-code is used when the request is for something that cannot happen. For example, there might be a request to cancel a Job that has already been canceled or aborted by the system. The IPP Client SHOULD NOT repeat the request.

SERVER_ERROR_MULTIPLE_DOCUMENT_JOBS_NOT_SUPPORTED

public static final StatusCode SERVER_ERROR_MULTIPLE_DOCUMENT_JOBS_NOT_SUPPORTED

The IPP object does not support multiple Documents per Job, and a Client attempted to supply Document data with a second Send-Document or Send-URI operation.

Method Detail

values

public static StatusCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StatusCode c : StatusCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StatusCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public short getCode()

Gets the value of the statuscode.

Returns:

2-byte code from 0x0000 to 0x7fff

of

public static StatusCode of(int id)

Allows you to map a value to the corresponding statuscode

Parameters:

id - e.g. 0x0000

Returns:

status code, e.g. SUCCESSFUL_OK