jdk/src/java.desktop/share/classes/java/awt/desktop/UserSessionEvent.java
author azvegint
Thu, 24 Mar 2016 02:22:01 +0300
changeset 36903 addc2e9d4bd4
child 43833 205cd5dd58a9
permissions -rw-r--r--
8143227: Platform-Specific Desktop Features Reviewed-by: prr, serb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36903
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     1
/*
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     4
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    10
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    15
 * accompanied this code).
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    16
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    20
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    23
 * questions.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    24
 */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    25
package java.awt.desktop;
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    26
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    27
/**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    28
 * Event sent when the user session has been changed.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    29
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    30
 * Some systems may provide a reason of a user session change.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    31
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    32
 * @see UserSessionListener#userSessionActivated(AppEvent.UserSessionEvent)
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    33
 * @see UserSessionListener#userSessionDeactivated(AppEvent.UserSessionEvent)
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    34
 *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    35
 * @since 9
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    36
 */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    37
public final class UserSessionEvent extends AppEvent {
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    38
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    39
    private static final long serialVersionUID = 6747138462796569055L;
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    40
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    41
    private final Reason reason;
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    42
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    43
    /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    44
     * Kinds of available reasons of user session change.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    45
     */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    46
    public static enum Reason {
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    47
        /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    48
         * The system does not provide a reason for a session change.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    49
         */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    50
        UNSPECIFIED,
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    51
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    52
        /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    53
         * The session was connected/disconnected to the console terminal.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    54
         */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    55
        CONSOLE,
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    56
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    57
        /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    58
         * The session was connected/disconnected to the remote terminal.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    59
         */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    60
        REMOTE,
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    61
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    62
        /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    63
         * The session has been locked/unlocked.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    64
         */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    65
        LOCK
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    66
    }
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    67
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    68
    /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    69
     * Constructs a {@code UserSessionEvent}
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    70
     *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    71
     * @param reason of session change
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    72
     */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    73
    public UserSessionEvent(Reason reason) {
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    74
        this.reason = reason;
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    75
    }
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    76
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    77
    /**
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    78
     * Gets a reason of the user session change.
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    79
     *
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    80
     * @return reason a reason
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    81
     * @see Reason#UNSPECIFIED
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    82
     * @see Reason#CONSOLE
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    83
     * @see Reason#REMOTE
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    84
     * @see Reason#LOCK
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    85
     */
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    86
    public Reason getReason() {
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    87
        return reason;
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    88
    }
addc2e9d4bd4 8143227: Platform-Specific Desktop Features
azvegint
parents:
diff changeset
    89
}