Package org.commonjava.indy.content

Class AbstractContentGenerator

java.lang.Object

org.commonjava.indy.content.AbstractContentGenerator

All Implemented Interfaces:

ContentGenerator

public abstract class AbstractContentGenerator
extends Object
implements ContentGenerator

Convenience abstract class for ContentGenerator implementations to extend. This allows content generators to only implement the methods they care about.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContentGenerator()

Method Summary

Modifier and Type	Method	Description
List<StoreResource>	generateDirectoryContent(org.commonjava.indy.model.core.ArtifactStore store, String path, List<StoreResource> existing, org.commonjava.maven.galley.event.EventMetadata eventMetadata)	Generate resources for any missing files that this generator can create.
org.commonjava.maven.galley.model.Transfer	generateFileContent(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata)	Generate dynamic content in the event it's not found in the ArtifactStore.
List<StoreResource>	generateGroupDirectoryContent(org.commonjava.indy.model.core.Group group, List<org.commonjava.indy.model.core.ArtifactStore> members, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata)	Generate resources for merged group files that this generator can create.
org.commonjava.maven.galley.model.Transfer	generateGroupFileContent(org.commonjava.indy.model.core.Group group, List<org.commonjava.indy.model.core.ArtifactStore> members, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata)	Generate dynamic content for a group.
void	handleContentDeletion(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata)	Tidy up any generated content associated with the deleted file
void	handleContentStorage(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.model.Transfer result, org.commonjava.maven.galley.event.EventMetadata eventMetadata)	Tidy up any generated content associated with the stored file

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.commonjava.indy.content.ContentGenerator

canProcess

Constructor Detail

AbstractContentGenerator

protected AbstractContentGenerator()

Method Detail

handleContentStorage

public void handleContentStorage(org.commonjava.indy.model.core.ArtifactStore store,
                                 String path,
                                 org.commonjava.maven.galley.model.Transfer result,
                                 org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                          throws IndyWorkflowException

Description copied from interface: ContentGenerator

Tidy up any generated content associated with the stored file

Specified by:

handleContentStorage in interface ContentGenerator

Throws:

IndyWorkflowException

handleContentDeletion

public void handleContentDeletion(org.commonjava.indy.model.core.ArtifactStore store,
                                  String path,
                                  org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                           throws IndyWorkflowException

Description copied from interface: ContentGenerator

Tidy up any generated content associated with the deleted file

Specified by:

handleContentDeletion in interface ContentGenerator

Throws:

IndyWorkflowException

generateFileContent

public org.commonjava.maven.galley.model.Transfer generateFileContent(org.commonjava.indy.model.core.ArtifactStore store,
                                                                      String path,
                                                                      org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                                               throws IndyWorkflowException

Description copied from interface: ContentGenerator

Generate dynamic content in the event it's not found in the ArtifactStore. This is secondary to the main content retrieval logic, as a last effort to avoid returning a missing result.

Specified by:

generateFileContent in interface ContentGenerator

Throws:

IndyWorkflowException

generateDirectoryContent

public List<StoreResource> generateDirectoryContent(org.commonjava.indy.model.core.ArtifactStore store,
                                                    String path,
                                                    List<StoreResource> existing,
                                                    org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                             throws IndyWorkflowException

Description copied from interface: ContentGenerator

Generate resources for any missing files that this generator can create. This is meant to contribute to an existing directory listing, so the existing resources are given in order to allow the generator to determine whether a new resources is warranted.

Specified by:

generateDirectoryContent in interface ContentGenerator

Throws:

IndyWorkflowException

generateGroupFileContent

public org.commonjava.maven.galley.model.Transfer generateGroupFileContent(org.commonjava.indy.model.core.Group group,
                                                                           List<org.commonjava.indy.model.core.ArtifactStore> members,
                                                                           String path,
                                                                           org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                                                    throws IndyWorkflowException

Description copied from interface: ContentGenerator

Generate dynamic content for a group. This is the PRIMARY form of group access, with secondary action being to attempt normal retrieval from one of the member stores.

Specified by:

generateGroupFileContent in interface ContentGenerator

Throws:

IndyWorkflowException

generateGroupDirectoryContent

public List<StoreResource> generateGroupDirectoryContent(org.commonjava.indy.model.core.Group group,
                                                         List<org.commonjava.indy.model.core.ArtifactStore> members,
                                                         String path,
                                                         org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                                  throws IndyWorkflowException

Description copied from interface: ContentGenerator

Generate resources for merged group files that this generator can create.

Specified by:

generateGroupDirectoryContent in interface ContentGenerator

Throws:

IndyWorkflowException