FtpMessage (JORAM 5.24.0 API)

java.lang.Object
- com.scalagent.joram.mom.dest.ftp.FtpMessage

```
public class FtpMessage
extends Object
```
An FtpMessage encapsulates a proprietary message which is also used for effective MOM transport facility.

Field Summary

Fields
Modifier and Type Field Description

private Message sharedMsg

Constructor Summary

Constructors
Constructor Description

FtpMessage(Message sharedMsg)
Instantiates an FtpMessage wrapping a consumed shared simple message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearProperties()`
`Object`	`clone()`
`boolean`	`getBooleanProperty(String key)`
`String`	`getIdentifier()`	The message identifier.
`long`	`getLongProperty(String key)`
`Object`	`getObjectProperty(String key)`
`Enumeration`	`getPropertyNames()`
`Message`	`getSharedMessage()`
`String`	`getStringProperty(String key)`
`boolean`	`propertyExists(String key)`
`void`	`setObjectProperty(String key, Object value)`
`void`	`setStringProperty(String key, String value)`
`String`	`toString()`

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

Field Detail
- sharedMsg
```
private Message sharedMsg
```

Constructor Detail
- FtpMessage
```
public FtpMessage(Message sharedMsg)
```
  Instantiates an FtpMessage wrapping a consumed shared simple message.
  
  Parameters:
  
  sharedMsg - The shared message to wrap.

Method Detail

getSharedMessage
```
public Message getSharedMessage()
```
Returns:

shared message structure

getIdentifier
```
public String getIdentifier()
```
The message identifier.

Returns:

identifier

getStringProperty

public String getStringProperty(String key)

getLongProperty

public long getLongProperty(String key)

getBooleanProperty

public boolean getBooleanProperty(String key)

getObjectProperty

public Object getObjectProperty(String key)

clone
```
public Object clone()
```
Overrides:

clone in class Object

clearProperties
```
public void clearProperties()
```

getPropertyNames
```
public Enumeration getPropertyNames()
```

setObjectProperty

public void setObjectProperty(String key,
                              Object value)

setStringProperty

public void setStringProperty(String key,
                              String value)

propertyExists

public boolean propertyExists(String key)

toString
```
public String toString()
```
Overrides:

toString in class Object