org.apache.shiro.authz.aop.GuestAnnotationHandler Maven / Gradle / Ivy
/*
* 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.shiro.authz.aop;
import java.lang.annotation.Annotation;
import org.apache.shiro.authz.AuthorizationException;
import org.apache.shiro.authz.UnauthenticatedException;
import org.apache.shiro.authz.annotation.RequiresGuest;
/**
* Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresGuest RequiresGuest} annotation
* is declared, and if so, ensures the calling Subject does not
* have an {@link org.apache.shiro.subject.Subject#getPrincipal() identity} before invoking the method.
*
* This annotation essentially ensures that subject.{@link org.apache.shiro.subject.Subject#getPrincipal() getPrincipal()} == null.
*
* @since 0.9.0
*/
public class GuestAnnotationHandler extends AuthorizingAnnotationHandler {
/**
* Default no-argument constructor that ensures this interceptor looks for
*
* {@link org.apache.shiro.authz.annotation.RequiresGuest RequiresGuest} annotations in a method
* declaration.
*/
public GuestAnnotationHandler() {
super(RequiresGuest.class);
}
/**
* Ensures that the calling Subject is NOT a user, that is, they do not
* have an {@link org.apache.shiro.subject.Subject#getPrincipal() identity} before continuing. If they are
* a user ({@link org.apache.shiro.subject.Subject#getPrincipal() Subject.getPrincipal()} != null), an
* AuthorizingException will be thrown indicating that execution is not allowed to continue.
*
* @param a the annotation to check for one or more roles
* @throws org.apache.shiro.authz.AuthorizationException
* if the calling Subject is not a "guest".
*/
public void assertAuthorized(Annotation a) throws AuthorizationException {
if (a instanceof RequiresGuest && getSubject().getPrincipal() != null) {
throw new UnauthenticatedException("Attempting to perform a guest-only operation. The current Subject is " +
"not a guest (they have been authenticated or remembered from a previous login). Access " +
"denied.");
}
}
}