FileMessagingTarget (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.target.impl.AbstractMessagingTarget
- - xdi2.messaging.target.impl.graph.GraphMessagingTarget
  - - xdi2.messaging.target.impl.file.FileMessagingTarget

All Implemented Interfaces:

Cloneable, MessagingTarget, Prototype<GraphMessagingTarget>
```
public class FileMessagingTarget
extends GraphMessagingTarget
```
An XDI messaging target backed by a file in one of the serialization formats.

Author:

markus

Nested Class Summary
- Nested classes/interfaces inherited from interface xdi2.messaging.target.Prototype
  Prototype.PrototypingContext

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_MIMETYPE

static String DEFAULT_PATH

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_MIMETYPE`
`static String`	`DEFAULT_PATH`

Constructor Summary

Constructors
Constructor and Description

FileMessagingTarget()

Constructors
Constructor and Description
`FileMessagingTarget()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)` Executes a message envelope by executing all its messages.
`String`	`getMimeType()`
`String`	`getPath()`
`void`	`init()` This method gets called when the messaging target is initialized.
`void`	`setMimeType(String mimeType)`
`void`	`setPath(String path)`
`void`	`shutdown()` This method gets called when the messaging target is no longer needed.

Methods inherited from class xdi2.messaging.target.impl.graph.GraphMessagingTarget
after, before, exception, getAddressHandler, getGraph, getGraphContextHandler, getOwnerPeerRootXDIArc, getStatementHandler, instanceFor, setGraph, setOwnerPeerRootXDIArc

Methods inherited from class xdi2.messaging.target.impl.AbstractMessagingTarget
after, after, before, before, execute, execute, execute, execute, getContributors, getInterceptors, setContributors, setInterceptors

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

- Field Detail
  - DEFAULT_PATH
```
public static final String DEFAULT_PATH
```
    See Also:
    Constant Field Values
  - DEFAULT_MIMETYPE
```
public static final String DEFAULT_MIMETYPE
```
- Constructor Detail
  - FileMessagingTarget
```
public FileMessagingTarget()
```
- Method Detail
  - init
```
public void init()
          throws Exception
```
    Description copied from interface: MessagingTarget
    
    This method gets called when the messaging target is initialized.
    
    Specified by:
    
    init in interface MessagingTarget
    
    Overrides:
    
    init in class GraphMessagingTarget
    
    Throws:
    
    Exception
  - shutdown
```
public void shutdown()
              throws Exception
```
    Description copied from interface: MessagingTarget
    
    This method gets called when the messaging target is no longer needed.
    
    Specified by:
    
    shutdown in interface MessagingTarget
    
    Overrides:
    
    shutdown in class GraphMessagingTarget
    
    Throws:
    
    Exception
  - execute
```
public void execute(MessageEnvelope messageEnvelope,
           MessageResult messageResult,
           ExecutionContext executionContext)
             throws Xdi2MessagingException
```
    Description copied from class: AbstractMessagingTarget
    
    Executes a message envelope by executing all its messages.
    
    Specified by:
    
    execute in interface MessagingTarget
    
    Overrides:
    
    execute in class AbstractMessagingTarget
    
    Parameters:
    messageEnvelope - The XDI message envelope containing XDI messages to be executed.
    messageResult - The message result.
    executionContext - An "execution context" object that carries state between messaging targets, interceptors and contributors.
    
    Throws:
    
    Xdi2MessagingException
  - getPath
```
public String getPath()
```
  - setPath
```
public void setPath(String path)
```
  - getMimeType
```
public String getMimeType()
```
  - setMimeType
```
public void setMimeType(String mimeType)
```

Class FileMessagingTarget

Nested Class Summary

Nested classes/interfaces inherited from interface xdi2.messaging.target.Prototype

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xdi2.messaging.target.impl.graph.GraphMessagingTarget

Methods inherited from class xdi2.messaging.target.impl.AbstractMessagingTarget

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PATH

DEFAULT_MIMETYPE

Constructor Detail

FileMessagingTarget

Method Detail

init

shutdown

execute

getPath

setPath

getMimeType

setMimeType