Files
alfresco-community-repo/source/java/org/alfresco/web/api/APIRequest.java
David Caruana 257568270d OpenSearch Impl
- addition of icons (for search engine, feed and feed entries)
- configurable items per page
- addition of feed entry relevance (score) (ATOM only)
- addition for generator & author feed elements (ATOM only)
- guest url argument support
- logging (log4j.logger.org.alfresco.web.api=DEBUG)
- addition of abstract web api plug-in (for building new url web services)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4668 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-12-20 00:38:47 +00:00

114 lines
2.4 KiB
Java

/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* 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.alfresco.web.api;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
/**
* API Service Request
*
* @author davidc
*/
public class APIRequest extends HttpServletRequestWrapper
{
/**
* Enumerartion of HTTP Methods
*/
public enum HttpMethod
{
GET;
// TODO: Complete list...
}
/**
* Enumeration of "required" Authentication level
*/
public enum RequiredAuthentication
{
None,
Guest,
User
}
/**
* Construct
*
* @param req
*/
/*package*/ APIRequest(HttpServletRequest req)
{
super(req);
}
/**
* Gets the HTTP Method
*
* @return Http Method
*/
public HttpMethod getHttpMethod()
{
String method = getMethod().trim().toUpperCase();
return HttpMethod.valueOf(method);
}
/**
* Gets the Alfresco Context URL
*
* @return context url e.g. http://localhost:port/alfresco
*/
public String getPath()
{
return getScheme() + "://" + getServerName() + ":" + getServerPort() + getContextPath();
}
/**
* Gets the Alfresco Service URL
*
* @return service url e.g. http://localhost:port/alfresco/service
*/
public String getServicePath()
{
return getPath() + getServletPath();
}
/**
* Gets the currently authenticated username
*
* @return username
*/
public String getAuthenticatedUsername()
{
return AuthenticationUtil.getCurrentUserName();
}
/**
* Determine if Guest User?
*
* @return true => guest user
*/
public boolean isGuest()
{
return Boolean.valueOf(getParameter("guest"));
}
}