org.hippoecm.hst.configuration.channel
Class BlueprintService

java.lang.Object
  org.hippoecm.hst.configuration.channel.BlueprintService

All Implemented Interfaces:

Blueprint

public class BlueprintService
extends Object
implements Blueprint

Field Summary

static String

SUBSITE_TEMPLATES_PATH

Constructor Summary

BlueprintService(javax.jcr.Node blueprint)

Method Summary

Channel	createChannel() Creates a new channel with ID 'null'.
String	getContentRoot() The contentRoot must start with a / and be a valid jcr path
String	getDescription()
String	getId() Unique id for this blueprint
String	getName() The name of the blue print as provided in the property hst:name, if the property doesn't exist, the id (node name) is returned as the name.
javax.jcr.Node	getNode(javax.jcr.Session session)
boolean	hasContentPrototype() Does the blueprint have a content prototype.

Methods inherited from class java.lang.Object

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

Field Detail

SUBSITE_TEMPLATES_PATH

public static final String SUBSITE_TEMPLATES_PATH

See Also:

Constant Field Values

Constructor Detail

BlueprintService

public BlueprintService(javax.jcr.Node blueprint)
                 throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

Method Detail

getId

public String getId()

Description copied from interface: Blueprint

Unique id for this blueprint

Specified by:

getId in interface Blueprint

Returns:

The node name

getName

public String getName()

Description copied from interface: Blueprint

The name of the blue print as provided in the property hst:name, if the property doesn't exist, the id (node name) is returned as the name.

Specified by:

getName in interface Blueprint

Returns:

the name of the blue print.

getDescription

public String getDescription()

Specified by:

getDescription in interface Blueprint

Returns:

value of hst:description of the blueprint node, returns null if the property doesn't exist.

getContentRoot

public String getContentRoot()

Description copied from interface: Blueprint

The contentRoot must start with a / and be a valid jcr path

Specified by:

getContentRoot in interface Blueprint

Returns:

absolute path of the hst:contentRoot of the blueprint node, returns null if the property doesn't exist.

createChannel

public Channel createChannel()

Description copied from interface: Blueprint

Creates a new channel with ID 'null'. The channel can be persisted using ChannelManager.persist(java.lang.String, org.hippoecm.hst.configuration.channel.Channel).

Specified by:

createChannel in interface Blueprint

Returns:

a new, unpersisted channel

getNode

public javax.jcr.Node getNode(javax.jcr.Session session)
                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

hasContentPrototype

public boolean hasContentPrototype()

Description copied from interface: Blueprint

Does the blueprint have a content prototype. If so, it will be used to create a content structure.

Specified by:

hasContentPrototype in interface Blueprint

Returns:

true if a prototype exists