org.hippoecm.hst.configuration.channel

Interface ChannelManager

public interface ChannelManager

Management interface for Channels. Basic Channel operations are provided.

Method Summary

Modifier and Type	Method and Description
void	addChannelManagerEventListeners(ChannelManagerEventListener... channelManagerEventListeners) Adds channel manager listeners.
boolean	canUserModifyChannels() Can the current user (set in HstSubject) create or modify channels.
String	persist(String blueprintId, org.onehippo.cms7.services.hst.Channel channel) Persists a channel.
void	removeChannelManagerEventListeners(ChannelManagerEventListener... channelManagerEventListeners) Removes channel manager listeners.
void	save(org.onehippo.cms7.services.hst.Channel channel) Deprecated. This method is deprecated by {save(String, Channel)} since version 4.0.0. Save channel properties. If the URL path of the new channel is not empty, all path-steps except the last one should already map to an existing mount. When invoking this method, an HstSubject context must be provided with the credentials necessary to persist the channel.
void	save(String hostGroupName, org.onehippo.cms7.services.hst.Channel channel) Save channel properties for the given host group.

Method Detail

persist

String persist(String blueprintId,
               org.onehippo.cms7.services.hst.Channel channel)
        throws ChannelException

Persists a channel. Will create the mounts, sites and configuration when the channel is new.

When invoking this method, an HstSubject context must be provided with the credentials necessary to persist the channel.

The persisted channel can be retrieved again via VirtualHosts.getChannelById(String, String) with the returned channel ID.

Parameters:

blueprintId - blueprint that contains prototypes for mount, site and hst configuration

channel - a channel instance to be persisted

Returns:

the channel ID of the created channel

Throws:

ChannelException - with type @{link ChannelException.Type#MOUNT_NOT_FOUND} when all but the last path-step in the URL path of a new channel do not map to existing mounts. The exception has one parameter: the absolute JCR path of the missing mount.

ChannelException - with type @{link ChannelException.Type#MOUNT_EXISTS} when the mount of a new channel already exists. The exception has one parameter: the absolute JCR path of the existing mount.

save

@Deprecated
void save(org.onehippo.cms7.services.hst.Channel channel)
                throws ChannelException

Deprecated. This method is deprecated by {save(String, Channel)} since version 4.0.0.
Save channel properties. If the URL path of the new channel is not empty, all path-steps except the last one should already map to an existing mount.

When invoking this method, an HstSubject context must be provided with the credentials necessary to persist the channel.

Parameters:

channel - the channel to persist

Throws:

ChannelException - with type @{link ChannelException.Type#MOUNT_NOT_FOUND} when all but the last path-step in the URL path of a new channel do not map to existing mounts, or the URL path of an existing channel does not map to an existing mount. The exception has one parameter: the absolute JCR path of the missing mount.

ChannelException - with type ChannelException.Type.CHANNEL_LOCKED, ChannelException.Type.CHANNEL_OUT_OF_SYNC or ChannelException.Type.UNKNOWN when the channel could not be persisted.

save

void save(String hostGroupName,
          org.onehippo.cms7.services.hst.Channel channel)
   throws ChannelException

Save channel properties for the given host group. If the URL path of the new channel is not empty, all path-steps except the last one should already map to an existing mount.

Parameters:

hostGroupName -

channel -

Throws:

ChannelException

canUserModifyChannels

boolean canUserModifyChannels()

Can the current user (set in HstSubject) create or modify channels.

Returns:

true when the user can create a channel, false otherwise

addChannelManagerEventListeners

void addChannelManagerEventListeners(ChannelManagerEventListener... channelManagerEventListeners)

Adds channel manager listeners.

Parameters:

channelManagerEventListeners -

removeChannelManagerEventListeners

void removeChannelManagerEventListeners(ChannelManagerEventListener... channelManagerEventListeners)

Removes channel manager listeners.

Parameters:

channelManagerEventListeners -