com.cafesoft.cams.agent.http
Class CamsHttpAgentStatusCode

java.lang.Object
  |
  +--com.cafesoft.cams.agent.http.CamsHttpAgentStatusCode

public class CamsHttpAgentStatusCode

extends Object

The CamsHttpAgentStatusCode class is a typesafe constant enumeration of CamsHttpAgent status codes.

Since:

6/11/03

Field Summary

static CamsHttpAgentStatusCode	SC_DONE The agent has fully responded to the HTTP client.
static CamsHttpAgentStatusCode	SC_GRANTED The agent has determined that access to the associated HTTP resource is granted.
static CamsHttpAgentStatusCode	SC_PENDING The agent has not yet set the response code: the response is pending complete processing by the agent.
static CamsHttpAgentStatusCode	SC_REDIRECT The agent has sent an HTTP redirect (HTTP response code 302) to the HTTP client in response to the HTTP request.

Method Summary

int	getValue() Get the integer value that represents the CamsHttpAgentStatusCode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SC_PENDING

public static final CamsHttpAgentStatusCode SC_PENDING

The agent has not yet set the response code: the response is pending complete processing by the agent. If a caller checks the status code before invoking the agent this value will be returned.

SC_GRANTED

public static final CamsHttpAgentStatusCode SC_GRANTED

The agent has determined that access to the associated HTTP resource is granted. The enclosing web server component should take whatever action is appropriate to return the resource to the HTTP client.

SC_REDIRECT

public static final CamsHttpAgentStatusCode SC_REDIRECT

The agent has sent an HTTP redirect (HTTP response code 302) to the HTTP client in response to the HTTP request. The redirect URL is either: 1. The configured cams.login.page if access is denied because authentication is required. 2. The originally-requested URL, if the current request was an authentication request that succeeded. 3. The configured error URL, the if the current request was an authenticatioin request that failed. 4. The configured Cams error page if a general agent error occured. 5. The configured Cams "access denied" page if access to the requested resource is denied.

SC_DONE

public static final CamsHttpAgentStatusCode SC_DONE

The agent has fully responded to the HTTP client. The enclosing web server component must ensure that no additional response is sent to the HTTP client. This response will be returned if an error occurs within the CamsHttpAgent and a full HTTP/HTML error page is returned. Usually, this will happen only if access is denied to the "access denied" or "error" page and the agent sends a full response to avoid an infinite redirection loop.

Method Detail

getValue

public int getValue()

Get the integer value that represents the CamsHttpAgentStatusCode.

Returns:

an integer value that represents the CamsHttpAgentStatusCode.