/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.deployment.annotation.handlers;
import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
import java.util.logging.Level;
import javax.annotation.security.DenyAll;
import javax.annotation.security.PermitAll;
import javax.annotation.security.RolesAllowed;
import com.sun.enterprise.deployment.EjbDescriptor;
import com.sun.enterprise.deployment.MethodDescriptor;
import com.sun.enterprise.deployment.MethodPermission;
import com.sun.enterprise.deployment.Role;
import com.sun.enterprise.deployment.annotation.AnnotatedElementHandler;
import com.sun.enterprise.deployment.annotation.AnnotationInfo;
import com.sun.enterprise.deployment.annotation.AnnotationProcessorException;
import com.sun.enterprise.deployment.annotation.HandlerProcessingResult;
import com.sun.enterprise.deployment.annotation.context.EjbContext;
import com.sun.enterprise.util.TypeUtil;
/**
* This handler is responsible for handling the
* javax.annotation.security.RolesAllowed.
*
* @author Shing Wai Chan
*/
public class RolesAllowedHandler extends AbstractAttributeHandler implements PostProcessor {
public RolesAllowedHandler() {
}
/**
* @return the annoation type this annotation handler is handling
*/
public Class<? extends Annotation> getAnnotationType() {
return RolesAllowed.class;
}
protected HandlerProcessingResult processAnnotation(AnnotationInfo ainfo,
EjbContext[] ejbContexts) throws AnnotationProcessorException {
AnnotatedElement ae = (AnnotatedElement)ainfo.getAnnotatedElement();
if (ae.isAnnotationPresent(DenyAll.class) ||
ae.isAnnotationPresent(PermitAll.class)) {
log(Level.SEVERE, ainfo,
localStrings.getLocalString(
"enterprise.deployment.annotation.handlers.inconsistentsecannotation",
"This annotation is not consistent with other annotations. One cannot have more than one of @RolesAllowed, @PermitAll, @DenyAll in the same AnnotatedElement."));
return getDefaultFailedResult();
}
RolesAllowed rolesAllowedAn = (RolesAllowed)ainfo.getAnnotation();
for (EjbContext ejbContext : ejbContexts) {
EjbDescriptor ejbDesc = ejbContext.getDescriptor();
if (ElementType.TYPE.equals(ainfo.getElementType())) {
// postpone the processing at the end
ejbContext.addPostProcessInfo(ainfo, this);
} else {
Method annMethod = (Method) ainfo.getAnnotatedElement();
for (Object next : ejbDesc.getSecurityBusinessMethodDescriptors()) {
MethodDescriptor md = (MethodDescriptor)next;
Method m = md.getMethod(ejbDesc);
if (TypeUtil.sameMethodSignature(m, annMethod)) {
// override by xml
if (!hasMethodPermissionsFromDD(md, ejbDesc)) {
addMethodPermissions(rolesAllowedAn, ejbDesc, md);
}
}
}
}
}
return getDefaultProcessedResult();
}
/**
* @return an array of annotation types this annotation handler would
* require to be processed (if present) before it processes it's own
* annotation type.
*/
public Class<? extends Annotation>[] getTypeDependencies() {
return getEjbAnnotationTypes();
}
protected boolean supportTypeInheritance() {
return true;
}
public void postProcessAnnotation(AnnotationInfo ainfo,
AnnotatedElementHandler aeHandler)
throws AnnotationProcessorException {
EjbContext ejbContext = (EjbContext)aeHandler;
EjbDescriptor ejbDesc = ejbContext.getDescriptor();
RolesAllowed rolesAllowedAn = (RolesAllowed)ainfo.getAnnotation();
if (!ejbContext.isInherited() &&
(ejbDesc.getMethodPermissionsFromDD() == null ||
ejbDesc.getMethodPermissionsFromDD().size() == 0)) {
for (MethodDescriptor md : getMethodAllDescriptors(ejbDesc)) {
addMethodPermissions(rolesAllowedAn, ejbDesc, md);
}
} else {
Class classAn = (Class)ainfo.getAnnotatedElement();
for (Object next : ejbDesc.getSecurityBusinessMethodDescriptors()) {
MethodDescriptor md = (MethodDescriptor)next;
Method m = md.getMethod(ejbDesc);
// override by existing info
if (classAn.equals(ejbContext.getDeclaringClass(md)) &&
!hasMethodPermissionsFromDD(md, ejbDesc)) {
addMethodPermissions(rolesAllowedAn, ejbDesc, md);
}
}
}
}
/**
* Add roles and permissions to given method in EjbDescriptor.
* @param rolesAllowedAn
* @param ejbDesc
* @param md
*/
private void addMethodPermissions(RolesAllowed rolesAllowedAn,
EjbDescriptor ejbDesc, MethodDescriptor md) {
for (String roleName : rolesAllowedAn.value()) {
Role role = new Role(roleName);
// add role if not exists
ejbDesc.getEjbBundleDescriptor().addRole(role);
ejbDesc.addPermissionedMethod(new MethodPermission(role), md);
}
}
}
|
