alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Struts example source code file (PrincipalProxy.java)

This example Struts source code file (PrincipalProxy.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Struts tags/keywords

http, httpservletrequest, httpservletrequest, principal, principal, principalproxy, principalproxy, request, response, security, servlet, string, string

The Struts PrincipalProxy.java source code

/*
 * $Id: PrincipalProxy.java 651946 2008-04-27 13:41:38Z apetrelli $
 *
 * 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.struts2.interceptor;

import java.security.Principal;

import javax.servlet.http.HttpServletRequest;

/**
 * Proxy interface used together with PrincipalAware interface. It allows indirect
 * access to HttpServletRequest or PortletRequest Principal related methods.
 */
public interface PrincipalProxy {

    /**
     * True if the user is in the given role
     *
     * @param role The role
     * @return True if the user is in that role
     */
    boolean isUserInRole(String role);

    /**
     * Gets the user principal
     *
     * @return The principal
     */
    Principal getUserPrincipal();

    /**
     * Gets the user id
     *
     * @return The user id
     */
    String getRemoteUser();

    /**
     * Is the request using https?
     *
     * @return True if using https
     */
    boolean isRequestSecure();

    /**
     * Gets the request.
     *
     * @return The request
     * @deprecated To obtain the HttpServletRequest in your action, use
     *             {@link org.apache.struts2.servlet.ServletRequestAware}, since this method will be dropped in future.
     */
    HttpServletRequest getRequest();
}

Other Struts examples (source code examples)

Here is a short list of links related to this Struts PrincipalProxy.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.