logticketstatisticsafterreturningadvice.java

CAS在Tomcat中实现单点登录项目,单点登录（Single Sign On , 简称 SSO ）是目前比较流行的服务于企业业务整合的解决方案之一

/*
 * Copyright 2007 The JA-SIG Collaborative. All rights reserved. See license
 * distributed with this file and available online at
 * http://www.ja-sig.org/products/cas/overview/license/
 */
package org.jasig.cas.stat.advice;

import java.lang.reflect.Method;
import java.util.Properties;

import org.jasig.cas.authentication.principal.Service;
import org.jasig.cas.stat.TicketStatisticsManager;
import org.jasig.cas.ticket.ServiceTicket;
import org.jasig.cas.ticket.registry.TicketRegistry;
import org.jasig.cas.util.annotation.NotEmpty;
import org.jasig.cas.util.annotation.NotNull;
import org.springframework.aop.AfterReturningAdvice;

/**
 * After returning AOP advice which updates <code>TicketStatistics</code>
 * state at the specific target's object joinpoints.
 * <p>
 * Note: the joinpoints captured by a pointcut are assumed to be the ones that
 * deal with <code>Ticket's</code> state. Those joinpoints (method invocation
 * names) should be properly configured as keys in the <b>statsStateMutators
 * </b> property and must be mapped to the appropriate ticket statistics mutator
 * method names of the <code>TicketStatisticsManager</code>
 * <p>
 * The following properties are required to be set:
 * <ul>
 * <li> <code>statsStateMutators</code> - The property set mapping the CAS
 * methods to the methods in the TicketStatistics Manager.</li>
 * <li> <code>ticketRegistry</code> - The registry that holds the ticket
 * information.</li>
 * <li> <code>ticketStatsManager</code> - The manager of the Ticket Stats,
 * charged with maintaining the count.</li>
 * </ul>
 * 
 * @author Scott Battaglia
 * @author Dmitriy Kopylenko
 * @version $Revision: 42053 $ $Date: 2007-06-10 09:17:55 -0400 (Sun, 10 Jun 2007) $
 * @since 3.0
 * @see org.jasig.cas.stat.TicketStatisticsManager
 * @see org.jasig.cas.ticket.registry.TicketRegistry
 */
public final class LogTicketStatisticsAfterReturningAdvice implements
    AfterReturningAdvice {

    /** The method to monitor for proxy tickets. */
    private static final String PROXY_TICKET_METHOD = "grantServiceTicket";

    /** The mapping of CAS methods to TicketStatistics methods. */
    @NotEmpty
    private Properties statsStateMutators = new Properties();

    /** The TicketStatisticsManager to update the statistics. */
    @NotNull
    private TicketStatisticsManager ticketStatsManager;

    /** The registry to monitor. */
    @NotNull
    private TicketRegistry ticketRegistry;

    public void afterReturning(final Object returnValue, final Method method,
        final Object[] args, final Object target) throws Throwable {
        if (returnValue == null) {
            return;
        }

        String statsStateMutatorMethodName = this.statsStateMutators
            .getProperty(method.getName());

        if (statsStateMutatorMethodName == null) {
            return;
        }

        if (method.getName().equals(PROXY_TICKET_METHOD)) {
            ServiceTicket serviceTicket = (ServiceTicket) this.ticketRegistry
                .getTicket((String) returnValue);

            /*
             * TODO: this needs to be more sophisticated, as web service become
             * more popular this check may not be true. we have a proxy ticket!!
             */
            if ((serviceTicket.getGrantingTicket().getAuthentication()
                .getPrincipal() instanceof Service)
                && (serviceTicket.getGrantingTicket().getGrantingTicket() != null)) {
                this.ticketStatsManager.incrementNumberOfProxyTicketsVended();
                return;
            }
        }

        Method statsStateMutatorMethod = this.ticketStatsManager.getClass()
            .getMethod(statsStateMutatorMethodName, (Class<?>[]) null);
        statsStateMutatorMethod.invoke(this.ticketStatsManager, (Object[]) null);
    }

    /**
     * @param ticketStatsManager The TicketStatisticsManager to set.
     */
    public void setTicketStatsManager(
        final TicketStatisticsManager ticketStatsManager) {
        this.ticketStatsManager = ticketStatsManager;
    }

    /**
     * @param statsStateMutators The statsStateMutators to set.
     */
    public void setStatsStateMutators(final Properties statsStateMutators) {
        this.statsStateMutators = statsStateMutators;
    }

    /**
     * @param ticketRegistry the TicketRegistry to set.
     */
    public void setTicketRegistry(final TicketRegistry ticketRegistry) {
        this.ticketRegistry = ticketRegistry;
    }
}