    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface java.security.Padding

public interface Padding

This interface is implemented by classes that provide a general-purpose padding scheme, such as the one described in PKCS#5 or in RFC 1423 (PEM).

##

pad(byte[], int, int)
  Returns the padding for a given array of bytes.
paddingScheme()
  Returns the standard name of the padding scheme implemented.
padLength(int)
  Returns the absolute value of the increase in size which a padding operation would cause on input data of a given length.
unpad(byte[], int, int)
  Given the specified subarray of bytes that includes padding bytes, returns the index indicating where padding starts.

##

pad

     public abstract int pad(byte in[],
                             int off,
                             int len)

  Returns the padding for a given array of bytes. The padded bytes are written to the same buffer that is used for input ("in").

  Parameters:
    in - the buffer to pad.
    off - the offset into the `in` buffer of the first byte in the group of bytes to be padded.
    len - the number of bytes from the `in` buffer, starting at `off`, that need to be padded.
  Returns:
    the number of padding bytes written to out.
  See Also:
    blockSize

unpad

     public abstract int unpad(byte in[],
                               int off,
                               int len)

  Given the specified subarray of bytes that includes padding bytes, returns the index indicating where padding starts.

  Parameters:
    in - the buffer containing the bytes.
    off - the starting offset in the `in` buffer of the bytes to be checked to determine where padding starts.
    len - the number of bytes from the `in` buffer to check, starting at offset `off`.
  Returns:
    the index into the `in` buffer indicating where the padding starts.

padLength

     public abstract int padLength(int len)

  Returns the absolute value of the increase in size which a padding operation would cause on input data of a given length.

  Parameters:
    len - the length of the data which is to be padded.
  Returns:
    the absolute value of the increase in size which a padding operation would cause on input data of the specified length.

paddingScheme

     public abstract String paddingScheme()

  Returns the standard name of the padding scheme implemented. See Appendix A in the Java Cryptography Extension API Specification & Reference for more information about standard names for padding schemes.

  Returns:
    the standard name of the padding scheme, such as "PKCS#5".

    All Packages  Class Hierarchy  This Package  Previous  Next  Index