/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/* Copyright  (c) 2002 Graz University of Technology. All rights reserved.

 *

 * Redistribution and use in  source and binary forms, with or without

 * modification, are permitted  provided that the following conditions are met:

 *

 * 1. Redistributions of  source code must retain the above copyright notice,

 *    this list of conditions and the following disclaimer.

 *

 * 2. Redistributions in  binary form must reproduce the above copyright notice,

 *    this list of conditions and the following disclaimer in the documentation

 *    and/or other materials provided with the distribution.

 *

 * 3. The end-user documentation included with the redistribution, if any, must

 *    include the following acknowledgment:

 *

 *    "This product includes software developed by IAIK of Graz University of

 *     Technology."

 *

 *    Alternately, this acknowledgment may appear in the software itself, if

 *    and wherever such third-party acknowledgments normally appear.

 *

 * 4. The names "Graz University of Technology" and "IAIK of Graz University of

 *    Technology" must not be used to endorse or promote products derived from

 *    this software without prior written permission.

 *

 * 5. Products derived from this software may not be called

 *    "IAIK PKCS Wrapper", nor may "IAIK" appear in their name, without prior

 *    written permission of Graz University of Technology.

 *

 *  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED

 *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE LICENSOR BE

 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,

 *  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,

 *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON

 *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

 *  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

 *  POSSIBILITY  OF SUCH DAMAGE.

 */

package sun.security.pkcs11.wrapper;

/**

 * class CK_SESSION_INFO provides information about a session.<p>

 * <B>PKCS#11 structure:</B>

 * <PRE>

 * typedef struct CK_SESSION_INFO {  

 *   CK_SLOT_ID slotID;  

 *   CK_STATE state;  

 *   CK_FLAGS flags;  

 *   CK_ULONG ulDeviceError;  

 * } CK_SESSION_INFO;

 * </PRE>

 *

 * @author Karl Scheibelhofer <Karl.Scheibelhofer@iaik.at>

 * @author Martin Schlaeffer <schlaeff@sbox.tugraz.at>

 */

public class CK_SESSION_INFO {

    /**

     * <B>PKCS#11:</B>

     * <PRE>

     *   CK_SLOT_ID slotID;

     * </PRE>

     */

    public long slotID;

    /**

     * <B>PKCS#11:</B>

     * <PRE>

     *   CK_STATE state;

     * </PRE>

     */

    public long state;

    /**

     * <B>PKCS#11:</B>

     * <PRE>

     *   CK_FLAGS flags;

     * </PRE>

     */

    public long flags;          /* see below */

    /* ulDeviceError was changed from CK_USHORT to CK_ULONG for

     * v2.0 */

    /**

     * <B>PKCS#11:</B>

     * <PRE>

     *   CK_ULONG ulDeviceError;

     * </PRE>

     */

    public long ulDeviceError;  /* device-dependent error code */

    public CK_SESSION_INFO(long slotID, long state,

                           long flags, long ulDeviceError) {

        this.slotID = slotID;

        this.state = state;

        this.flags = flags;

        this.ulDeviceError = ulDeviceError;

    }

    /**

     * Returns the string representation of CK_SESSION_INFO.

     *

     * @return the string representation of CK_SESSION_INFO

     */

    public String toString() {

        StringBuffer buffer = new StringBuffer();

        buffer.append(Constants.INDENT);

        buffer.append("slotID: ");

        buffer.append(String.valueOf(slotID));

        buffer.append(Constants.NEWLINE);

        buffer.append(Constants.INDENT);

        buffer.append("state: ");

        buffer.append(Functions.sessionStateToString(state));

        buffer.append(Constants.NEWLINE);

        buffer.append(Constants.INDENT);

        buffer.append("flags: ");

        buffer.append(Functions.sessionInfoFlagsToString(flags));

        buffer.append(Constants.NEWLINE);

        buffer.append(Constants.INDENT);

        buffer.append("ulDeviceError: ");

        buffer.append(Functions.toHexString(ulDeviceError));

        //buffer.append(Constants.NEWLINE);

        return buffer.toString() ;

    }

}