org.camunda.bpm.cycle.connector.vfs
Class VfsConnector

java.lang.Object
  org.camunda.bpm.cycle.connector.Connector
      org.camunda.bpm.cycle.connector.vfs.VfsConnector

public class VfsConnector
extends Connector

Field Summary

static String	BASE_PATH_KEY
static String	DEFAULT_BASE_PATH

Constructor Summary

VfsConnector()

Method Summary

ConnectorNode	createNode(String parentId, String label, ConnectorNodeType type, String message)
void	deleteNode(ConnectorNode node, String message)
List<ConnectorNode>	getChildren(ConnectorNode node)
InputStream	getContent(ConnectorNode node) Get the contents of the given node as an input stream.
ContentInformation	getContentInformation(ConnectorNode node) Returns a ContentInformation for the given connector node.
ConnectorNode	getNode(String id) Returns a ConnectorNode to the assigned id.
ConnectorNode	getRoot()
void	init(ConnectorConfiguration config)
boolean	isSupportsCommitMessage()
boolean	needsLogin()
ContentInformation	updateContent(ConnectorNode node, InputStream newContent, String message)

Methods inherited from class org.camunda.bpm.cycle.connector.Connector

dispose, getConfiguration, getId, init, login, setConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BASE_PATH_KEY

public static final String BASE_PATH_KEY

See Also:

Constant Field Values

DEFAULT_BASE_PATH

public static final String DEFAULT_BASE_PATH

Constructor Detail

VfsConnector

public VfsConnector()

Method Detail

getChildren

public List<ConnectorNode> getChildren(ConnectorNode node)

Specified by:

getChildren in class Connector

getContent

public InputStream getContent(ConnectorNode node)

Description copied from class: Connector

Get the contents of the given node as an input stream. Implementations must handle the node correctly, especially concerning the nodes type accessible via ConnectorNode.getType().

Specified by:

getContent in class Connector

Returns:

the input stream of the file

init

public void init(ConnectorConfiguration config)

Overrides:

init in class Connector

getRoot

public ConnectorNode getRoot()

Specified by:

getRoot in class Connector

updateContent

public ContentInformation updateContent(ConnectorNode node,
                                        InputStream newContent,
                                        String message)
                                 throws Exception

Specified by:

updateContent in class Connector

Throws:

Exception

getNode

public ConnectorNode getNode(String id)

Description copied from class: Connector

Returns a ConnectorNode to the assigned id. If a ConnectorNode could not be found, the value null will be returned.

Specified by:

getNode in class Connector

Parameters:

id - Represents the id of a ConnectorNode to search.

Returns:

A ConnectorNode to the assigned id or null if no ConnectorNode found.

createNode

public ConnectorNode createNode(String parentId,
                                String label,
                                ConnectorNodeType type,
                                String message)

Specified by:

createNode in class Connector

deleteNode

public void deleteNode(ConnectorNode node,
                       String message)

Specified by:

deleteNode in class Connector

getContentInformation

public ContentInformation getContentInformation(ConnectorNode node)

Description copied from class: Connector

Returns a ContentInformation for the given connector node. May never return null or throw an exception.

Specified by:

getContentInformation in class Connector

Returns:

needsLogin

public boolean needsLogin()

Specified by:

needsLogin in class Connector

isSupportsCommitMessage

public boolean isSupportsCommitMessage()

Specified by:

isSupportsCommitMessage in class Connector