1/*
2 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.security.auth;
27
28/**
29 * This class abstracts an NT security token
30 * and provides a mechanism to do same-process security impersonation.
31 */
32
33public class NTNumericCredential {
34
35    private long impersonationToken;
36
37    /**
38     * Create an {@code NTNumericCredential} with an integer value.
39     *
40     * @param token the Windows NT security token for this user.
41     */
42    public NTNumericCredential(long token) {
43        this.impersonationToken = token;
44    }
45
46    /**
47     * Return an integer representation of this
48     * {@code NTNumericCredential}.
49     *
50     * @return an integer representation of this
51     *          {@code NTNumericCredential}.
52     */
53    public long getToken() {
54        return impersonationToken;
55    }
56
57    /**
58     * Return a string representation of this {@code NTNumericCredential}.
59     *
60     * @return a string representation of this {@code NTNumericCredential}.
61     */
62    public String toString() {
63        java.text.MessageFormat form = new java.text.MessageFormat
64                (sun.security.util.ResourcesMgr.getAuthResourceString
65                        ("NTNumericCredential.name"));
66        Object[] source = {Long.toString(impersonationToken)};
67        return form.format(source);
68    }
69
70    /**
71     * Compares the specified Object with this {@code NTNumericCredential}
72     * for equality.  Returns true if the given object is also a
73     * {@code NTNumericCredential} and the two NTNumericCredentials
74     * represent the same NT security token.
75     *
76     * @param o Object to be compared for equality with this
77     *          {@code NTNumericCredential}.
78     *
79     * @return true if the specified Object is equal to this
80     *          {@code NTNumericCredential}.
81     */
82    public boolean equals(Object o) {
83        if (o == null)
84            return false;
85
86        if (this == o)
87            return true;
88
89        if (!(o instanceof NTNumericCredential))
90            return false;
91        NTNumericCredential that = (NTNumericCredential)o;
92
93        if (impersonationToken == that.getToken())
94            return true;
95        return false;
96    }
97
98    /**
99     * Return a hash code for this {@code NTNumericCredential}.
100     *
101     * @return a hash code for this {@code NTNumericCredential}.
102     */
103    public int hashCode() {
104        return (int)this.impersonationToken;
105    }
106}
107