UserEvent.java example

Explorer
guacamole-client-master
/*
 * 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.guacamole.net.event;

import org.apache.guacamole.net.auth.UserContext;

/**
 * Abstract basis for events which may have an associated UserContext when
 * triggered.
 *
 * @author Michael Jumper
 */
public interface UserEvent {

    /**
     * Returns the current UserContext of the user triggering the event, if any.
     *
     * @return The current UserContext of the user triggering the event, if
     *         any, or null if no UserContext is associated with the event.
     */
    UserContext getUserContext();

}