contrib.com.ibm.as400.access.ValidationListDataToEncrypt Maven / Gradle / Ivy
Show all versions of jt400 Show documentation
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: ValidationListDataToEncrypt.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 2001-2010 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////
package com.ibm.as400.access;
/**
* Used to specify the data to
* encrypt when adding or changing a validation list entry.
*
* @author Thomas Johnson ([email protected]), Kingland Systems Corporation
*/
public class ValidationListDataToEncrypt extends ValidationListTranslatedData {
/**
* Constructs a ValidationListDataToEncrypt.
*/
public ValidationListDataToEncrypt() {
super();
}
/**
* Constructs a ValidationListDataToEncrypt from a structure stored as IBM i bytes.
*
* The offset indicates the starting position of the structure in the
* given buffer.
*
* @param buffer byte[]
* @param offset int
*/
public ValidationListDataToEncrypt(byte[] buffer, int offset) {
super(buffer, offset);
}
/**
* Constructs a ValidationListDataToEncrypt from the specified IBM i bytes
* which are encoded in the given ccsid.
*
* @param ccsid int
* @param bytes byte[]
*/
public ValidationListDataToEncrypt(int ccsid, byte[] bytes) {
super(ccsid, bytes);
}
/**
* Constructs a ValidationListDataToEncrypt from the given string.
*
* The translated bytes are derived by converting the string to IBM i bytes
* using the given ccsid. The as400 is required to perform the
* conversion from text to bytes. A ccsid of 0 indicates to use the ccsid
* of the current user.
*
* @param s java.lang.String
* @param ccsid int
* @param as400 com.ibm.as400.access.AS400
*/
public ValidationListDataToEncrypt(String s, int ccsid, AS400 as400) {
super(s, ccsid, as400);
}
/**
* Returns the length to be specified in the written IBM i byte structure
* if the assigned data is null.
*
* Typically this value is 0. However, there are some cases where
* other values must be returned to maintain proper behavior. For
* example, when changing an entry a structure must be specified for the
* data to encrypt, even if the encrypted data should not be changed.
* However, if the data length in the structure is set to 0 instead of -1,
* the existing encrypted data is wiped out. This is undesirable since
* we don't always want the encrypted data changed. We might want to
* modify the unencrypted data (i.e. user statistics) while leaving
* the encrypted data (i.e. user password) unchanged.
*
* @return int
*/
protected int getWriteNullDataLength() {
return -1;
}
}