001    /*
002     * Copyright (c) 2002-2005 the original author or authors.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     * 
008     * http://www.apache.org/licenses/LICENSE-2.0
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.security;
017    
018    import org.springframework.context.ApplicationEvent;
019    import org.springframework.security.Authentication;
020    import org.springframework.security.providers.UsernamePasswordAuthenticationToken;
021    
022    /**
023     * Parent for all RCP security related application events.
024     * 
025     * @author Ben Alex
026     * @author Larry Streepy
027     */
028    public abstract class ClientSecurityEvent extends ApplicationEvent {
029        /**
030         * This token is used when the real authentication token is null and it needs to be
031         * used as the source of an event.
032         */
033        public static final Authentication NO_AUTHENTICATION = new UsernamePasswordAuthenticationToken(
034            "NO_AUTHENTICATION", "NO_AUTHENTICATION" );
035    
036        /**
037         * Constructor. Use the given authentication token as the source of the event, if this
038         * is null, then the {@link #NO_AUTHENTICATION} token is used instead.
039         * 
040         * @param authentication token, may be null
041         */
042        public ClientSecurityEvent(Authentication authentication) {
043            super( authentication == null ? NO_AUTHENTICATION : authentication );
044        }
045    }