/*
 * DataHeader.java
 * 
 * 
 * 
 ====================================================
 Professional Data Security (PDS)

 http://crypto.brettlee.com
 ====================================================

 Copyright (c) 2009-2011, Brett Lee
 All rights reserved.

 Portions Copyright (C) 1995-2008, Sun Microsystems, Inc.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
   * 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.
   * Neither the name of the ORGANIZATION nor the names of its contributors
     may be used to endorse or promote products derived from this software
     without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS 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 COPYRIGHT HOLDER OR CONTRIBUTORS 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 com.brettlee.crypto;


import java.io.Serializable;



///////////////////////////////////////////////////////////////////////
/**
* DataHeader :: Describe the PDS data
*
*   Stuff to be saved:
*     1.  Version number of PDS Data Header
*     2.  Format of the Data
*
*/
///////////////////////////////////////////////////////////////////////

class DataHeader implements Serializable {

	
	private static final long serialVersionUID = 0000000000000000001L;


	// Our variables
	//
	int version = 2;		// Version number of the Data Header
	int dataFormat;			// Supported Data Formats: 0 = PDS Binary File, 1 = PDS Directory
	String ksName;			// Absolute Path to the KeyStore
	String keyAlias;		// Name (alias) of the Key
	
	public static final int kBINARY = 0;
	public static final int kDIRECTORY = 1;


	///////////////////////////////////////////////////////////////
	//
	// Our getters and setters
	// 


	// Version of the DataHeader
	// -----------------------------

	void setVersion( int n ) {
		version = n;
	}
	int getVersion() {
		return version;
	}


	// Data Format
	// -----------------------------

	void setDataFormat( int n ) {
		dataFormat = n;
	}
	int getDataFormat() {
		return dataFormat;
	}



	// KeyStore
	// -----------------------------
	
	void setKsPathAndName(String keyStorePathAndName) {
		ksName = StateObject.pathToState( keyStorePathAndName, false );
	}
	String getKsPathAndName() {
		return StateObject.pathToDisplay( ksName, false );
	}



	// Key Alias
	// -----------------------------

	void setKeyAlias(String alias) {
		keyAlias = alias;
	}
	String getKeyAlias() {
		return keyAlias;
	}

}