org.apache.maven.plugin.assembly.model
Class Repository

java.lang.Object
  org.apache.maven.plugin.assembly.model.Repository

All Implemented Interfaces:

Serializable

public class Repository
extends Object
implements Serializable

Defines a Maven repository to be included in the assembly. The artifacts available to be included in a repository are your project's dependency artifacts. The repository created contains the needed metadata entries and also contains both sha1 and md5 checksums. This is useful for creating archives which will be deployed to internal repositories.
NOTE: Currently, only artifacts from the central repository are allowed.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Repository()

Method Summary

void	addExclude(String string) Method addExclude.
void	addGroupVersionAlignment(GroupVersionAlignment groupVersionAlignment) Method addGroupVersionAlignment.
void	addInclude(String string) Method addInclude.
String	getDirectoryMode() Get similar to a UNIX permission, sets the directory mode of the directories included.
List<String>	getExcludes() Method getExcludes.
String	getFileMode() Get similar to a UNIX permission, sets the file mode of the files included.
List<GroupVersionAlignment>	getGroupVersionAlignments() Method getGroupVersionAlignments.
List<String>	getIncludes() Method getIncludes.
String	getOutputDirectory() Get sets the output directory relative to the root of the root directory of the assembly.
String	getScope() Get specifies the scope for artifacts included in this repository.
boolean	isIncludeMetadata() Get if set to true, this property will trigger the creation of repository metadata which will allow the repository to be used as a functional remote repository.
void	removeExclude(String string) Method removeExclude.
void	removeGroupVersionAlignment(GroupVersionAlignment groupVersionAlignment) Method removeGroupVersionAlignment.
void	removeInclude(String string) Method removeInclude.
void	setDirectoryMode(String directoryMode) Set similar to a UNIX permission, sets the directory mode of the directories included.
void	setExcludes(List<String> excludes) Set when <exclude> subelements are present, they define a set of dependency artifact coordinates to exclude.
void	setFileMode(String fileMode) Set similar to a UNIX permission, sets the file mode of the files included.
void	setGroupVersionAlignments(List<GroupVersionAlignment> groupVersionAlignments) Set specifies that you want to align a group of artifacts to a specified version.
void	setIncludeMetadata(boolean includeMetadata) Set if set to true, this property will trigger the creation of repository metadata which will allow the repository to be used as a functional remote repository.
void	setIncludes(List<String> includes) Set when <include> subelements are present, they define a set of artifact coordinates to include.
void	setOutputDirectory(String outputDirectory) Set sets the output directory relative to the root of the root directory of the assembly.
void	setScope(String scope) Set specifies the scope for artifacts included in this repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

Repository

public Repository()

Method Detail

addExclude

public void addExclude(String string)

Method addExclude.

Parameters:

string -

addGroupVersionAlignment

public void addGroupVersionAlignment(GroupVersionAlignment groupVersionAlignment)

Method addGroupVersionAlignment.

Parameters:

groupVersionAlignment -

addInclude

public void addInclude(String string)

Method addInclude.

Parameters:

string -

getDirectoryMode

public String getDirectoryMode()

Get similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Returns:

String

getExcludes

public List<String> getExcludes()

Method getExcludes.

Returns:

List

getFileMode

public String getFileMode()

Get similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Returns:

String

getGroupVersionAlignments

public List<GroupVersionAlignment> getGroupVersionAlignments()

Method getGroupVersionAlignments.

Returns:

List

getIncludes

public List<String> getIncludes()

Method getIncludes.

Returns:

List

getOutputDirectory

public String getOutputDirectory()

Get sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory, directly beneath the root of the archive.

Returns:

String

getScope

public String getScope()

Get specifies the scope for artifacts included in this repository. Default scope value is "runtime". (Since 2.2).

Returns:

String

isIncludeMetadata

public boolean isIncludeMetadata()

Get if set to true, this property will trigger the creation of repository metadata which will allow the repository to be used as a functional remote repository. Default value is false.

Returns:

boolean

removeExclude

public void removeExclude(String string)

Method removeExclude.

Parameters:

string -

removeGroupVersionAlignment

public void removeGroupVersionAlignment(GroupVersionAlignment groupVersionAlignment)

Method removeGroupVersionAlignment.

Parameters:

groupVersionAlignment -

removeInclude

public void removeInclude(String string)

Method removeInclude.

Parameters:

string -

setDirectoryMode

public void setDirectoryMode(String directoryMode)

Set similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Parameters:

directoryMode -

setExcludes

public void setExcludes(List<String> excludes)

Set when <exclude> subelements are present, they define a set of dependency artifact coordinates to exclude. If none is present, then <excludes> represents no exclusions. Artifact coordinatess may be given in simple groupId:artifactId form, or they may be fully qualified in the form groupId:artifactId:type:version[:classifier]. Additionally, wildcards can be used, as in *:maven-*.

Parameters:

excludes -

setFileMode

public void setFileMode(String fileMode)

Set similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Parameters:

fileMode -

setGroupVersionAlignments

public void setGroupVersionAlignments(List<GroupVersionAlignment> groupVersionAlignments)

Set specifies that you want to align a group of artifacts to a specified version. A groupVersionAlignment is specified by providing one or more of <groupVersionAlignment> subelements.

Parameters:

groupVersionAlignments -

setIncludeMetadata

public void setIncludeMetadata(boolean includeMetadata)

Set if set to true, this property will trigger the creation of repository metadata which will allow the repository to be used as a functional remote repository. Default value is false.

Parameters:

includeMetadata -

setIncludes

public void setIncludes(List<String> includes)

Set when <include> subelements are present, they define a set of artifact coordinates to include. If none is present, then <includes> represents all valid values. Artifact coordinatess may be given in simple groupId:artifactId form, or they may be fully qualified in the form groupId:artifactId:type:version[:classifier]. Additionally, wildcards can be used, as in *:maven-*.

Parameters:

includes -

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

Set sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory, directly beneath the root of the archive.

Parameters:

outputDirectory -

setScope

public void setScope(String scope)

Set specifies the scope for artifacts included in this repository. Default scope value is "runtime". (Since 2.2).

Parameters:

scope -