info.magnolia.cms.exchange
Interface Syndicator

All Known Implementing Classes:

BaseSyndicatorImpl, SimpleSyndicator

public interface Syndicator

Basic activation contract. Provides methods to activate or de-activate content (either current or versioned).

Author:

Sameer Charles $Id: Syndicator.java 6443 2006-09-21 10:14:34Z scharles $

Method Summary

void	activate(java.lang.String parent, Content content) This will activate the specified node to all configured subscribers.
void	activate(java.lang.String parent, Content content, java.util.List<java.lang.String> orderBefore) This will activate the specified node to all configured subscribers.
void	activate(Subscriber subscriber, java.lang.String parent, Content content) This will activate the specified node to the specified subscriber.
void	activate(Subscriber subscriber, java.lang.String parent, Content content, java.util.List<java.lang.String> orderBefore) This will activate the specified node to the specified subscriber.
void	deactivate(Content node)
void	deactivate(Subscriber subscriber, Content node)
void	init(User user, java.lang.String repositoryName, java.lang.String workspaceName, Rule rule) Sets up the syndicator.

Method Detail

init

void init(User user,
          java.lang.String repositoryName,
          java.lang.String workspaceName,
          Rule rule)

Sets up the syndicator.

Parameters:

user - the user to use for the connection to the subscriber

repositoryName - the repository to transmit

workspaceName - the workspace to transmit

rule - the rules defining which nodes to transmit (node types)

activate

void activate(java.lang.String parent,
              Content content)
              throws ExchangeException,
                     javax.jcr.RepositoryException

This will activate the specified node to all configured subscribers.

Parameters:

parent - parent under which this page will be activated

content - to be activated

Throws:

javax.jcr.RepositoryException

ExchangeException

activate

void activate(java.lang.String parent,
              Content content,
              java.util.List<java.lang.String> orderBefore)
              throws ExchangeException,
                     javax.jcr.RepositoryException

This will activate the specified node to all configured subscribers.

Parameters:

parent - parent under which this page will be activated

content - to be activated

orderBefore - List of UUID to be used by the implementation to order this node after activation

Throws:

javax.jcr.RepositoryException

ExchangeException

activate

void activate(Subscriber subscriber,
              java.lang.String parent,
              Content content)
              throws ExchangeException,
                     javax.jcr.RepositoryException

This will activate the specified node to the specified subscriber.

Parameters:

subscriber -

parent - parent under which this page will be activated

content - to be activated

Throws:

javax.jcr.RepositoryException

ExchangeException

activate

void activate(Subscriber subscriber,
              java.lang.String parent,
              Content content,
              java.util.List<java.lang.String> orderBefore)
              throws ExchangeException,
                     javax.jcr.RepositoryException

This will activate the specified node to the specified subscriber.

Parameters:

subscriber -

parent - parent under which this page will be activated

content - to be activated

orderBefore - List of UUID to be used by the subscriber to order this node after activation

Throws:

javax.jcr.RepositoryException

ExchangeException

deactivate

void deactivate(Content node)
                throws ExchangeException,
                       javax.jcr.RepositoryException

Parameters:

node - to de-activate

Throws:

javax.jcr.RepositoryException

ExchangeException

deactivate

void deactivate(Subscriber subscriber,
                Content node)
                throws ExchangeException,
                       javax.jcr.RepositoryException

Parameters:

node - to de-activate

subscriber -

Throws:

javax.jcr.RepositoryException

ExchangeException