/*
* 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.guacamole.protocol;
/**
* All possible statuses returned by various Guacamole instructions, each having
* a corresponding code.
*
* @author Michael Jumper
*/
public enum GuacamoleStatus {
/**
* The operation succeeded.
*/
SUCCESS(200, 1000, 0x0000),
/**
* The requested operation is unsupported.
*/
UNSUPPORTED(501, 1011, 0x0100),
/**
* The operation could not be performed due to an internal failure.
*/
SERVER_ERROR(500, 1011, 0x0200),
/**
* The operation could not be performed as the server is busy.
*/
SERVER_BUSY(503, 1008, 0x0201),
/**
* The operation could not be performed because the upstream server is not
* responding.
*/
UPSTREAM_TIMEOUT(504, 1011, 0x0202),
/**
* The operation was unsuccessful due to an error or otherwise unexpected
* condition of the upstream server.
*/
UPSTREAM_ERROR(502, 1011, 0x0203),
/**
* The operation could not be performed as the requested resource does not
* exist.
*/
RESOURCE_NOT_FOUND(404, 1002, 0x0204),
/**
* The operation could not be performed as the requested resource is already
* in use.
*/
RESOURCE_CONFLICT(409, 1008, 0x0205),
/**
* The operation could not be performed because bad parameters were given.
*/
CLIENT_BAD_REQUEST(400, 1002, 0x0300),
/**
* Permission was denied to perform the operation, as the user is not yet
* authorized (not yet logged in, for example). As HTTP 401 has implications
* for HTTP-specific authorization schemes, this status continues to map to
* HTTP 403 ("Forbidden"). To do otherwise would risk unintended effects.
*/
CLIENT_UNAUTHORIZED(403, 1008, 0x0301),
/**
* Permission was denied to perform the operation, and this operation will
* not be granted even if the user is authorized.
*/
CLIENT_FORBIDDEN(403, 1008, 0x0303),
/**
* The client took too long to respond.
*/
CLIENT_TIMEOUT(408, 1002, 0x0308),
/**
* The client sent too much data.
*/
CLIENT_OVERRUN(413, 1009, 0x030D),
/**
* The client sent data of an unsupported or unexpected type.
*/
CLIENT_BAD_TYPE(415, 1003, 0x030F),
/**
* The operation failed because the current client is already using too
* many resources.
*/
CLIENT_TOO_MANY(429, 1008, 0x031D);
/**
* The most applicable HTTP error code.
*/
private final int http_code;
/**
* The most applicable WebSocket error code.
*/
private final int websocket_code;
/**
* The Guacamole protocol status code.
*/
private final int guac_code;
/**
* Initializes a GuacamoleStatusCode with the given HTTP and Guacamole
* status/error code values.
*
* @param http_code The most applicable HTTP error code.
* @param websocket_code The most applicable WebSocket error code.
* @param guac_code The Guacamole protocol status code.
*/
private GuacamoleStatus(int http_code, int websocket_code, int guac_code) {
this.http_code = http_code;
this.websocket_code = websocket_code;
this.guac_code = guac_code;
}
/**
* Returns the most applicable HTTP error code.
*
* @return The most applicable HTTP error code.
*/
public int getHttpStatusCode() {
return http_code;
}
/**
* Returns the most applicable HTTP error code.
*
* @return The most applicable HTTP error code.
*/
public int getWebSocketCode() {
return websocket_code;
}
/**
* Returns the corresponding Guacamole protocol status code.
*
* @return The corresponding Guacamole protocol status code.
*/
public int getGuacamoleStatusCode() {
return guac_code;
}
/**
* Returns the GuacamoleStatus corresponding to the given Guacamole
* protocol status code. If no such GuacamoleStatus is defined, null is
* returned.
*
* @param code
* The Guacamole protocol status code to translate into a
* GuacamoleStatus.
*
* @return
* The GuacamoleStatus corresponding to the given Guacamole protocol
* status code, or null if no such GuacamoleStatus is defined.
*/
public static GuacamoleStatus fromGuacamoleStatusCode(int code) {
// Search for a GuacamoleStatus having the given status code
for (GuacamoleStatus status : values()) {
if (status.getGuacamoleStatusCode() == code)
return status;
}
// No such status found
return null;
}
}