Utility (cybersource-sdk-java 6.2.13 API)

java.lang.Object
- com.cybersource.ws.client.Utility

```
public class Utility
extends Object
```
Containing useful constants and methods.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTH_SERVICE`
`static String`	`AUTH_SERVICE_NVP`
`static String`	`AUTH_SERVICE_XML_RUN_ATT`
`static String`	`CYBS_CERT_AUTH`
`static String`	`ELEM_CLIENT_ENVIRONMENT`
`static String`	`ELEM_CLIENT_LIBRARY`
`static String`	`ELEM_CLIENT_LIBRARY_VERSION`
`static String`	`ELEM_MERCHANT_ID`
`static String`	`ELEM_MERCHANT_REFERENCE_CODE`
`static String`	`ENVIRONMENT` Environment information.
`static int`	`HTTP_BAD_REQUEST` HTTP Status-Code 400: Bad Request.
`static String`	`KEY_ALIAS`
`static String`	`MERCHANT_TRANSACTION_IDENTIFIER`
`static String`	`MTI_FIELD_ERR_MSG`
`static String`	`NVP_LIBRARY` NVP library information.
`static String`	`ORIGIN_TIMESTAMP`
`static String`	`RESPONSE_TIME_REPLY`
`static String`	`SDK_ELAPSED_TIMESTAMP`
`static String`	`SERVER_ALIAS` Version number of this release.
`static String`	`VERSION`
`static String`	`XML_LIBRARY` XML library information.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`checkIfAuthServiceFieldExist(Document request, String nsURI)` Checks if the request documents contains ccAuthService element.
`static String`	`checkIfMTIFiledExist(Document request, String nsURI)` Checks if the request documents contains merchantTransactionIdentifier element.
`static Element`	`createElement(Document owner, String nsURI, String elementName, String textValue)` Creates an Element object in the CyberSource namespace.
`static Element`	`getElement(Document owner, String elementName, String nsURI)` Returns the Element object corresponding to the given element name.
`static String`	`getElementText(Document owner, String elementName, String nsURI)` Returns the text value of the given element name in the CyberSource namespace.
`static long`	`getResponseIssuedAtTime(String responseTime)`
`static long`	`getResponseTransitTime(long resIssuedAtTime)` This is the response transit time in seconds.
`static String`	`getStackTrace(Exception e)` Returns the stack trace of the supplied Exception object.
`static String`	`mapToString(Map src, boolean mask, int type)` Converts the contents of a Map object into a string, one name-value pair to a line and the name and value are separated by an equal sign.
`static DocumentBuilder`	`newDocumentBuilder()` Returns a DocumentBuilder object.
`static String`	`nodeToString(Node node)` Returns the string representation of the given Node object.
`static String`	`nodeToString(Node node, int type)` Returns the string representation of the given Node object.
`static byte[]`	`read(File file)` Reads the content of the given file into a byte array.
`static byte[]`	`read(InputStream in)` Reads the content of the given file into a byte array.
`static byte[]`	`read(String filename)` Reads the content of the given file into a byte array.
`static Properties`	`readProperties(String[] commandLineArgs)` Reads the properties from a file.
`static Document`	`readRequest(Properties props, String filename)` Read the request xml file
`static Document`	`readRequest(Properties props, String filename, String merchantId)` Read the request xml file
`static HashMap<String,String>`	`stringToMap(String src)` Converts a name-value pair string into a Map object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVER_ALIAS
```
public static final String SERVER_ALIAS
```
    Version number of this release.
    
    See Also:
    
    Constant Field Values
  - CYBS_CERT_AUTH
```
public static final String CYBS_CERT_AUTH
```
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - ORIGIN_TIMESTAMP
```
public static final String ORIGIN_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - SDK_ELAPSED_TIMESTAMP
```
public static final String SDK_ELAPSED_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - RESPONSE_TIME_REPLY
```
public static final String RESPONSE_TIME_REPLY
```
    See Also:
    
    Constant Field Values
  - MERCHANT_TRANSACTION_IDENTIFIER
```
public static final String MERCHANT_TRANSACTION_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - AUTH_SERVICE
```
public static final String AUTH_SERVICE
```
    See Also:
    
    Constant Field Values
  - AUTH_SERVICE_XML_RUN_ATT
```
public static final String AUTH_SERVICE_XML_RUN_ATT
```
    See Also:
    
    Constant Field Values
  - AUTH_SERVICE_NVP
```
public static final String AUTH_SERVICE_NVP
```
    See Also:
    
    Constant Field Values
  - ELEM_MERCHANT_ID
```
public static final String ELEM_MERCHANT_ID
```
    See Also:
    
    Constant Field Values
  - KEY_ALIAS
```
public static final String KEY_ALIAS
```
    See Also:
    
    Constant Field Values
  - ELEM_MERCHANT_REFERENCE_CODE
```
public static final String ELEM_MERCHANT_REFERENCE_CODE
```
    See Also:
    
    Constant Field Values
  - ELEM_CLIENT_LIBRARY
```
public static final String ELEM_CLIENT_LIBRARY
```
    See Also:
    
    Constant Field Values
  - ELEM_CLIENT_LIBRARY_VERSION
```
public static final String ELEM_CLIENT_LIBRARY_VERSION
```
    See Also:
    
    Constant Field Values
  - ELEM_CLIENT_ENVIRONMENT
```
public static final String ELEM_CLIENT_ENVIRONMENT
```
    See Also:
    
    Constant Field Values
  - HTTP_BAD_REQUEST
```
public static final int HTTP_BAD_REQUEST
```
    HTTP Status-Code 400: Bad Request.
    
    See Also:
    
    Constant Field Values
  - MTI_FIELD_ERR_MSG
```
public static final String MTI_FIELD_ERR_MSG
```
    See Also:
    
    Constant Field Values
  - NVP_LIBRARY
```
public static final String NVP_LIBRARY
```
    NVP library information.
  - XML_LIBRARY
```
public static final String XML_LIBRARY
```
    XML library information.
  - ENVIRONMENT
```
public static final String ENVIRONMENT
```
    Environment information.
- Method Detail
  - nodeToString
```
public static String nodeToString(Node node,
                                  int type)
```
    Returns the string representation of the given Node object. Used for logging or demo purposes only. As it employs some formatting parameters, parsing the string it returns may not result to a Node object exactly similar to the one passed to it.
    
    Parameters:
    
    node - the Node object whose string representation is wanted.
    
    type - either PCI.REQUEST or PCI.REPLY. Used for masking.
    
    Returns:
    
    the string representation of the given Node object.
  - nodeToString
```
public static String nodeToString(Node node)
```
    Returns the string representation of the given Node object. Used for logging or demo purposes only. As it employs some formatting parameters, parsing the string it returns may not result to a Node object exactly similar to the one passed to it.
    
    Parameters:
    
    node - the Node object whose string representation is wanted.
    
    Returns:
    
    the string representation of the given Node object.
  - readProperties
```
public static Properties readProperties(String[] commandLineArgs)
```
    Reads the properties from a file. If no filename was specified in the command-line, it will look for "cybs.properties" in the current directory.
    
    Parameters:
    
    commandLineArgs - the command-line arguments.
    
    Returns:
    
    Properties object containing the run-time properties required by the clients.
  - read
```
public static byte[] read(String filename)
                   throws IOException
```
    Reads the content of the given file into a byte array.
    
    Parameters:
    
    filename - name of the file to read.
    
    Returns:
    
    content of the file.
    
    Throws:
    
    IOException - if there was an error reading the file.
  - read
```
public static byte[] read(File file)
                   throws IOException
```
    Reads the content of the given file into a byte array.
    
    Parameters:
    
    file - File object to read.
    
    Returns:
    
    content of the file
    
    Throws:
    
    IOException - if there was an error reading the file.
  - read
```
public static byte[] read(InputStream in)
                   throws IOException
```
    Reads the content of the given file into a byte array.
    
    Parameters:
    
    in - InputStream object to read.
    
    Returns:
    
    content of the file
    
    Throws:
    
    IOException - if there was an error reading the file.
  - newDocumentBuilder
```
public static DocumentBuilder newDocumentBuilder()
                                          throws ParserConfigurationException
```
    Returns a DocumentBuilder object.
    
    Returns:
    
    a DocumentBuilder object.
    
    Throws:
    
    ParserConfigurationException - if no suitable parser implementation is found.
  - getElement
```
public static Element getElement(Document owner,
                                 String elementName,
                                 String nsURI)
```
    Returns the Element object corresponding to the given element name.
    
    Parameters:
    
    owner - Document object to search.
    
    elementName - local name to search for.
    
    nsURI - namespaceURI to used (may be null).
    
    Returns:
    
    the Element object corresponding to the given element name or null if none is found.
  - getElementText
```
public static String getElementText(Document owner,
                                    String elementName,
                                    String nsURI)
```
    Returns the text value of the given element name in the CyberSource namespace.
    
    Parameters:
    
    owner - Document object to search.
    
    elementName - local name to search for.
    
    nsURI - namespaceURI to used (may be null).
    
    Returns:
    
    the text value of the given element name in the CyberSource namespace or null if none is found.
  - getStackTrace
```
public static String getStackTrace(Exception e)
```
    Returns the stack trace of the supplied Exception object.
    
    Parameters:
    
    e - Exception object.
    
    Returns:
    
    the stack trace of the Exception object.
  - stringToMap
```
public static HashMap<String,String> stringToMap(String src)
```
    Converts a name-value pair string into a Map object.
    
    Parameters:
    
    src - String containing name-value pairs.
    
    Returns:
    
    resulting Map object; will be empty if the string was null or empty.
  - mapToString
```
public static String mapToString(Map src,
                                 boolean mask,
                                 int type)
```
    Converts the contents of a Map object into a string, one name-value pair to a line and the name and value are separated by an equal sign.
    
    Parameters:
    
    src - Map object whose contents are being converted.
    
    mask - Flag whether or not to mask "unsafe" fields.
    
    type - Relevant only when mask is true, indicates whether this is the request or the reply map. Pass either PCI.REQUEST or PCI.REPLY.
    
    Returns:
    
    resulting string; will be empty if the Map object was null or empty.
  - readRequest
```
public static Document readRequest(Properties props,
                                   String filename)
```
    Read the request xml file
    
    Parameters:
    
    props - Properties object to lookup properties in
    
    filename - Filename of file containing XML request
    
    Returns:
    
    Document Request from filename read as document
  - readRequest
```
public static Document readRequest(Properties props,
                                   String filename,
                                   String merchantId)
```
    Read the request xml file
    
    Parameters:
    
    props - Properties object to lookup properties in
    
    filename - Filename of file containing XML request
    
    merchantId - merchantId
    
    Returns:
    
    Document Request from filename read as document
  - createElement
```
public static Element createElement(Document owner,
                                    String nsURI,
                                    String elementName,
                                    String textValue)
```
    Creates an Element object in the CyberSource namespace.
    
    Parameters:
    
    owner - Document object to own the Element object.
    
    nsURI - Namespace URI to use.
    
    elementName - local name of Element object to create.
    
    textValue - text value of the new Element object.
    
    Returns:
    
    the newly created Element object.
  - getResponseIssuedAtTime
```
public static long getResponseIssuedAtTime(String responseTime)
```
  - getResponseTransitTime
```
public static long getResponseTransitTime(long resIssuedAtTime)
```
    This is the response transit time in seconds.
    
    Parameters:
    
    resIssuedAtTime -
    
    Returns:
    
    long
  - checkIfMTIFiledExist
```
public static String checkIfMTIFiledExist(Document request,
                                          String nsURI)
```
    Checks if the request documents contains merchantTransactionIdentifier element.
    
    Parameters:
    
    request - Document object to own the Element object.
    
    nsURI - Namespace URI to use.
    
    Returns:
    
    merchantTransactionIdentifier element value else null if not exist.
  - checkIfAuthServiceFieldExist
```
public static String checkIfAuthServiceFieldExist(Document request,
                                                  String nsURI)
```
    Checks if the request documents contains ccAuthService element.
    
    Parameters:
    
    request - Document object to own the Element object.
    
    nsURI - Namespace URI to use.
    
    Returns:
    
    ccAuthService element value else null if not exist.

Class Utility

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVER_ALIAS

CYBS_CERT_AUTH

VERSION

ORIGIN_TIMESTAMP

SDK_ELAPSED_TIMESTAMP

RESPONSE_TIME_REPLY

MERCHANT_TRANSACTION_IDENTIFIER

AUTH_SERVICE

AUTH_SERVICE_XML_RUN_ATT

AUTH_SERVICE_NVP

ELEM_MERCHANT_ID

KEY_ALIAS

ELEM_MERCHANT_REFERENCE_CODE

ELEM_CLIENT_LIBRARY

ELEM_CLIENT_LIBRARY_VERSION

ELEM_CLIENT_ENVIRONMENT

HTTP_BAD_REQUEST

MTI_FIELD_ERR_MSG

NVP_LIBRARY

XML_LIBRARY

ENVIRONMENT

Method Detail

nodeToString

nodeToString

readProperties

read

read

read

newDocumentBuilder

getElement

getElementText

getStackTrace

stringToMap

mapToString

readRequest

readRequest

createElement

getResponseIssuedAtTime

getResponseTransitTime

checkIfMTIFiledExist

checkIfAuthServiceFieldExist