1 /*
   2  * Copyright (c) 1999, 2002, 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 
  26 package com.sun.security.auth;
  27 
  28 /**
  29  * <p> This class abstracts an NT security token
  30  * and provides a mechanism to do same-process security impersonation.
  31  *
  32  */
  33 
  34 public class NTNumericCredential {
  35 
  36     private long impersonationToken;
  37 
  38     /**
  39      * Create an <code>NTNumericCredential</code> with an integer value.
  40      *
  41      * <p>
  42      *
  43      * @param token the Windows NT security token for this user. <p>
  44      *
  45      */
  46     public NTNumericCredential(long token) {
  47         this.impersonationToken = token;
  48     }
  49 
  50     /**
  51      * Return an integer representation of this
  52      * <code>NTNumericCredential</code>.
  53      *
  54      * <p>
  55      *
  56      * @return an integer representation of this
  57      *          <code>NTNumericCredential</code>.
  58      */
  59     public long getToken() {
  60         return impersonationToken;
  61     }
  62 
  63     /**
  64      * Return a string representation of this <code>NTNumericCredential</code>.
  65      *
  66      * <p>
  67      *
  68      * @return a string representation of this <code>NTNumericCredential</code>.
  69      */
  70     public String toString() {
  71         java.text.MessageFormat form = new java.text.MessageFormat
  72                 (sun.security.util.ResourcesMgr.getString
  73                         ("NTNumericCredential: name",
  74                         "sun.security.util.AuthResources"));
  75         Object[] source = {Long.toString(impersonationToken)};
  76         return form.format(source);
  77     }
  78 
  79     /**
  80      * Compares the specified Object with this <code>NTNumericCredential</code>
  81      * for equality.  Returns true if the given object is also a
  82      * <code>NTNumericCredential</code> and the two NTNumericCredentials
  83      * represent the same NT security token.
  84      *
  85      * <p>
  86      *
  87      * @param o Object to be compared for equality with this
  88      *          <code>NTNumericCredential</code>.
  89      *
  90      * @return true if the specified Object is equal equal to this
  91      *          <code>NTNumericCredential</code>.
  92      */
  93     public boolean equals(Object o) {
  94         if (o == null)
  95             return false;
  96 
  97         if (this == o)
  98             return true;
  99 
 100         if (!(o instanceof NTNumericCredential))
 101             return false;
 102         NTNumericCredential that = (NTNumericCredential)o;
 103 
 104         if (impersonationToken == that.getToken())
 105             return true;
 106         return false;
 107     }
 108 
 109     /**
 110      * Return a hash code for this <code>NTNumericCredential</code>.
 111      *
 112      * <p>
 113      *
 114      * @return a hash code for this <code>NTNumericCredential</code>.
 115      */
 116     public int hashCode() {
 117         return (int)this.impersonationToken;
 118     }
 119 }