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