org.apache.myfaces.trinidad.util.RequestType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation
Show all versions of trinidad-api Show documentation
Public API for the Apache MyFaces Trinidad project
/*
* 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.myfaces.trinidad.util;
/**
* Represents the type of request currently in the ExternalContext.
* All servlet requests will be of the SERVLET requestType whereas
* all of the other RequestTypes will be portlet type requests. There
* are a number of convenience methods on the RequestType enumeration
* which can be used to determine the capabilities of the current request.
*/
public enum RequestType
{
/**
* The type for all servlet requests. SERVLET request types are
* both client requests and response writable.
*/
SERVLET(true, true, false),
/**
* The type for a portlet RenderRequest. RENDER request types are
* for portlets and are response writable but are NOT client
* requests.
*/
RENDER(false, true, true),
/**
* The type for a portlet ActionRequest. ACTION request types are
* for portlets and are client requests but are NOT response
* writable.
*/
ACTION(true, false, true),
/**
* The type for a portlet ResourceRequest. RESOURCE request types
* are for portlets and are both client requests and response
* writable. RESOURCE request types will only be returned in a
* Portlet 2.0 portlet container.
*/
RESOURCE(true, true, true),
/**
* The type for a portlet EventRequest. EVENT request types
* are for portlets and are neither client requests nor response
* writable. EVENT request types will only be returned in a
* Portlet 2.0 portlet container.
*/
EVENT(false, false, true);
private boolean _client;
private boolean _writable;
private boolean _portlet;
RequestType(boolean client, boolean writable, boolean portlet)
{
_client = client;
_writable = writable;
_portlet = portlet;
}
/**
* Returns true
if this request was a direct
* result of a call from the client. This implies that
* the current application is the "owner" of the current
* request and that it has access to the inputStream, can
* get and set character encodings, etc. Currently all
* SERVLET, ACTION, and RESOURCE RequestTypes are client
* requests.
*
* @return true
if the current request is a
* client data type request and false
* if it is not.
*/
public boolean isRequestFromClient()
{
return _client;
}
/**
* Returns true
if the response for this
* RequestType is intended to produce output to the client.
* Currently the SERVLET, RENDER, and RESOURCE request are
* response writable.
*
* @return true
if the current request is
* intended to produce output and false
* if it is not.
*/
public boolean isResponseWritable()
{
return _writable;
}
/**
* Returns true
if the response for this
* RequestType originated from a JSR-168 or JSR-286
* portlet container. Currently RENDER, ACTION,
* RESOURCE, and EVENT RequestTypes are all portlet
* requests.
*
* @return true
if the current request
* originated inside of a JSR-168 or JSR-286
* Portlet Container or false
if
* it did not.
*/
public boolean isPortlet()
{
return _portlet;
}
}