Jt400Configuration (Camel :: Java Toolbox for IBM i 3.11.0 API)

java.lang.Object
- org.apache.camel.component.jt400.Jt400Configuration

@UriParams
public class Jt400Configuration
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Jt400Configuration.Format` Enumeration of supported data formats
`static class`	`Jt400Configuration.MessageAction`
`static class`	`Jt400Configuration.SearchType` SearchTypes for reading from Keyed Data Queues

Constructor Summary

Constructors
Constructor and Description

Jt400Configuration(String endpointUri, com.ibm.as400.access.AS400ConnectionPool connectionPool)

Constructors
Constructor and Description
`Jt400Configuration(String endpointUri, com.ibm.as400.access.AS400ConnectionPool connectionPool)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCcsid()`
`com.ibm.as400.access.AS400`	`getConnection()` Obtains an `AS400` object that connects to this endpoint.
`int`	`getCssid()` Returns the CCSID to use for the connection with the IBM i system.
`Jt400Configuration.Format`	`getFormat()` Returns the data format for sending messages.
`Jt400Configuration.MessageAction`	`getMessageAction()`
`String`	`getObjectPath()` Returns the fully qualified integrated file system path name of the target object of this endpoint.
`Integer[]`	`getOutputFieldsIdxArray()`
`Integer[]`	`getOutputFieldsLengthArray()`
`String`	`getPassword()` Returns the password of the IBM i user.
`String`	`getProcedureName()`
`int`	`getReadTimeout()`
`String`	`getSearchKey()`
`Jt400Configuration.SearchType`	`getSearchType()`
`String`	`getSystemName()` Returns the name of the IBM i system.
`Jt400Type`	`getType()`
`String`	`getUserID()` Returns the ID of the IBM i user.
`boolean`	`isGuiAvailable()` Returns whether IBM i prompting is enabled in the environment running Camel.
`boolean`	`isKeyed()`
`boolean`	`isSecured()`
`boolean`	`isSendingReply()`
`void`	`releaseConnection(com.ibm.as400.access.AS400 connection)` Releases a previously obtained `AS400` object from use.
`void`	`setCcsid(int ccsid)` Sets the CCSID to use for the connection with the IBM i system.
`void`	`setFieldsLength(String fieldsLength)`
`void`	`setFormat(Jt400Configuration.Format format)` Sets the data format for sending messages.
`void`	`setGuiAvailable(boolean guiAvailable)` Sets whether IBM i prompting is enabled in the environment running Camel.
`void`	`setKeyed(boolean keyed)` Whether to use keyed or non-keyed data queues.
`void`	`setMessageAction(Jt400Configuration.MessageAction messageAction)` Action to be taken on messages when read from a message queue.
`void`	`setObjectPath(String objectPath)`
`void`	`setOutputFieldsIdx(String outputFieldsIdx)`
`void`	`setOutputFieldsIdxArray(Integer[] outputFieldsIdxArray)` Specifies which fields (program parameters) are output parameters.
`void`	`setOutputFieldsLengthArray(Integer[] outputFieldsLengthArray)` Specifies the fields (program parameters) length as in the IBM i program definition.
`void`	`setPassword(String password)`
`void`	`setProcedureName(String procedureName)` Procedure name from a service program to call
`void`	`setReadTimeout(int readTimeout)` Timeout in millis the consumer will wait while trying to read a new message of the data queue.
`void`	`setSearchKey(String searchKey)` Search key for keyed data queues.
`void`	`setSearchType(Jt400Configuration.SearchType searchType)` Search type such as EQ for equal etc.
`void`	`setSecured(boolean secured)` Whether connections to IBM i are secured with SSL.
`void`	`setSendingReply(boolean sendingReply)` If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received.
`void`	`setSystemName(String systemName)`
`void`	`setType(Jt400Type type)` Whether to work with data queues or remote program call
`void`	`setUserID(String userID)`

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

- Constructor Detail
  - Jt400Configuration
```
public Jt400Configuration(String endpointUri,
                          com.ibm.as400.access.AS400ConnectionPool connectionPool)
                   throws URISyntaxException
```
    Throws:
    
    URISyntaxException
- Method Detail
  - getType
```
public Jt400Type getType()
```
  - setType
```
public void setType(Jt400Type type)
```
    Whether to work with data queues or remote program call
  - getSystemName
```
public String getSystemName()
```
    Returns the name of the IBM i system.
  - setSystemName
```
public void setSystemName(String systemName)
```
  - getUserID
```
public String getUserID()
```
    Returns the ID of the IBM i user.
  - setUserID
```
public void setUserID(String userID)
```
  - getPassword
```
public String getPassword()
```
    Returns the password of the IBM i user.
  - setPassword
```
public void setPassword(String password)
```
  - getObjectPath
```
public String getObjectPath()
```
    Returns the fully qualified integrated file system path name of the target object of this endpoint.
  - setObjectPath
```
public void setObjectPath(String objectPath)
```
  - getCssid
```
public int getCssid()
```
    Returns the CCSID to use for the connection with the IBM i system. Returns -1 if the CCSID to use is the default system CCSID.
  - setCcsid
```
public void setCcsid(int ccsid)
```
    Sets the CCSID to use for the connection with the IBM i system.
  - getFormat
```
public Jt400Configuration.Format getFormat()
```
    Returns the data format for sending messages.
  - setFormat
```
public void setFormat(Jt400Configuration.Format format)
```
    Sets the data format for sending messages.
  - isGuiAvailable
```
public boolean isGuiAvailable()
```
    Returns whether IBM i prompting is enabled in the environment running Camel.
  - setGuiAvailable
```
public void setGuiAvailable(boolean guiAvailable)
```
    Sets whether IBM i prompting is enabled in the environment running Camel.
  - getCcsid
```
public int getCcsid()
```
  - isKeyed
```
public boolean isKeyed()
```
  - setKeyed
```
public void setKeyed(boolean keyed)
```
    Whether to use keyed or non-keyed data queues.
  - getSearchKey
```
public String getSearchKey()
```
  - setSearchKey
```
public void setSearchKey(String searchKey)
```
    Search key for keyed data queues.
  - getSearchType
```
public Jt400Configuration.SearchType getSearchType()
```
  - setSearchType
```
public void setSearchType(Jt400Configuration.SearchType searchType)
```
    Search type such as EQ for equal etc.
  - getOutputFieldsIdxArray
```
public Integer[] getOutputFieldsIdxArray()
```
  - isSecured
```
public boolean isSecured()
```
  - setSecured
```
public void setSecured(boolean secured)
```
    Whether connections to IBM i are secured with SSL.
  - setOutputFieldsIdxArray
```
public void setOutputFieldsIdxArray(Integer[] outputFieldsIdxArray)
```
    Specifies which fields (program parameters) are output parameters.
  - getOutputFieldsLengthArray
```
public Integer[] getOutputFieldsLengthArray()
```
  - setOutputFieldsLengthArray
```
public void setOutputFieldsLengthArray(Integer[] outputFieldsLengthArray)
```
    Specifies the fields (program parameters) length as in the IBM i program definition.
  - getReadTimeout
```
public int getReadTimeout()
```
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Timeout in millis the consumer will wait while trying to read a new message of the data queue.
  - getProcedureName
```
public String getProcedureName()
```
  - setProcedureName
```
public void setProcedureName(String procedureName)
```
    Procedure name from a service program to call
  - getMessageAction
```
public Jt400Configuration.MessageAction getMessageAction()
```
  - setMessageAction
```
public void setMessageAction(Jt400Configuration.MessageAction messageAction)
```
    Action to be taken on messages when read from a message queue. Messages can be marked as old ("OLD"), removed from the queue ("REMOVE"), or neither ("SAME").
  - isSendingReply
```
public boolean isSendingReply()
```
  - setSendingReply
```
public void setSendingReply(boolean sendingReply)
```
    If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message.
  - setOutputFieldsIdx
```
public void setOutputFieldsIdx(String outputFieldsIdx)
```
  - setFieldsLength
```
public void setFieldsLength(String fieldsLength)
```
  - getConnection
```
public com.ibm.as400.access.AS400 getConnection()
```
    Obtains an AS400 object that connects to this endpoint. Since these objects represent limited resources, clients have the responsibility of releasing them when done.
    
    Returns:
    
    an AS400 object that connects to this endpoint
  - releaseConnection
```
public void releaseConnection(com.ibm.as400.access.AS400 connection)
```
    Releases a previously obtained AS400 object from use.
    
    Parameters:
    
    connection - a previously obtained AS400 object to release

Class Jt400Configuration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Jt400Configuration

Method Detail

getType

setType

getSystemName

setSystemName

getUserID

setUserID

getPassword

setPassword

getObjectPath

setObjectPath

getCssid

setCcsid

getFormat

setFormat

isGuiAvailable

setGuiAvailable

getCcsid

isKeyed

setKeyed

getSearchKey

setSearchKey

getSearchType

setSearchType

getOutputFieldsIdxArray

isSecured

setSecured

setOutputFieldsIdxArray

getOutputFieldsLengthArray

setOutputFieldsLengthArray

getReadTimeout

setReadTimeout

getProcedureName

setProcedureName

getMessageAction

setMessageAction

isSendingReply

setSendingReply

setOutputFieldsIdx

setFieldsLength

getConnection

releaseConnection