Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.core.api.pathsegment
Class PathSegmentComponent

java.lang.Object
  extended by org.nuxeo.runtime.model.DefaultComponent
      extended by org.nuxeo.ecm.core.api.pathsegment.PathSegmentComponent
All Implemented Interfaces:
PathSegmentService, Adaptable, Component, Extensible

public class PathSegmentComponent
extends DefaultComponent
implements PathSegmentService

Central service for the generation of a path segment for a document.


Field Summary
static String XP
           
 
Constructor Summary
PathSegmentComponent()
           
 
Method Summary
 void activate(ComponentContext context)
          Activates the component.
 void deactivate(ComponentContext context)
          Deactivates the component.
 String generatePathSegment(DocumentModel doc)
          Generate the path segment to use for a DocumentModel that's about to be created.
 void registerContribution(Object contrib, String xp, ComponentInstance contributor)
           
 void unregisterContribution(Object contrib, String xp, ComponentInstance contributor)
           
 
Methods inherited from class org.nuxeo.runtime.model.DefaultComponent
applicationStarted, getAdapter, registerExtension, unregisterExtension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XP

public static final String XP
See Also:
Constant Field Values
Constructor Detail

PathSegmentComponent

public PathSegmentComponent()
Method Detail

activate

public void activate(ComponentContext context)
              throws Exception
Description copied from interface: Component
Activates the component.

This method is called by the runtime when a component is activated.

Specified by:
activate in interface Component
Overrides:
activate in class DefaultComponent
Parameters:
context - the runtime context
Throws:
Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception
Description copied from interface: Component
Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:
deactivate in interface Component
Overrides:
deactivate in class DefaultComponent
Parameters:
context - the runtime context
Throws:
Exception - if an error occurs during activation

registerContribution

public void registerContribution(Object contrib,
                                 String xp,
                                 ComponentInstance contributor)
                          throws Exception
Overrides:
registerContribution in class DefaultComponent
Throws:
Exception

unregisterContribution

public void unregisterContribution(Object contrib,
                                   String xp,
                                   ComponentInstance contributor)
                            throws Exception
Overrides:
unregisterContribution in class DefaultComponent
Throws:
Exception

generatePathSegment

public String generatePathSegment(DocumentModel doc)
                           throws ClientException
Description copied from interface: PathSegmentService
Generate the path segment to use for a DocumentModel that's about to be created.

Specified by:
generatePathSegment in interface PathSegmentService
Parameters:
doc - the document
Returns:
the path segment, which must not contain any / character
Throws:
ClientException

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.