Package org.apache.ivy.plugins.resolver

Class FileSystemResolver

java.lang.Object

org.apache.ivy.plugins.resolver.AbstractResolver

org.apache.ivy.plugins.resolver.BasicResolver

org.apache.ivy.plugins.resolver.AbstractPatternsBasedResolver

org.apache.ivy.plugins.resolver.RepositoryResolver

org.apache.ivy.plugins.resolver.FileSystemResolver

All Implemented Interfaces:

Validatable, DependencyResolver, HasLatestStrategy

Direct Known Subclasses:

CacheResolver

public class FileSystemResolver
extends RepositoryResolver

Field Summary

Fields

Modifier and Type	Field	Description
private String	baseTransactionPattern	The pattern leading to the directory where files are published before being moved at the end of a transaction
private Map<String,String>	fullTransactionPatterns	Map between actual patterns and patterns used during the transaction to put files in a temporary directory
private Boolean	supportTransaction	When set indicates if this resolver supports transaction
private static final String	TRANSACTION_DESTINATION_SUFFIX
private static final Pattern	TRANSACTION_PATTERN
private String	transactional	Transactional mode.
private File	transactionDestDir	Location where files should end up at the end of the transaction
private File	transactionTempDir	Location where files are published during the transaction

Fields inherited from class org.apache.ivy.plugins.resolver.BasicResolver

DATE_FORMAT, DESCRIPTOR_OPTIONAL, DESCRIPTOR_REQUIRED

Constructor Summary

Constructors

Constructor	Description
FileSystemResolver()

Method Summary

Modifier and Type	Method	Description
void	abortPublishTransaction()
void	addArtifactPattern(String pattern)
void	addConfiguredArtifact(IvyPattern p)
void	addConfiguredIvy(IvyPattern p)
void	addIvyPattern(String pattern)	example of pattern : ~/Workspace/[module]/[module].ivy.xml
void	beginPublishTransaction(ModuleRevisionId module, boolean overwrite)
private void	checkSupportTransaction()
private void	closeTransaction()
void	commitPublishTransaction()
protected Collection<String>	filterNames(Collection<String> values)	Filters names before returning them in the findXXXNames or findTokenValues method.
protected String	getDestination(String pattern, Artifact artifact, ModuleRevisionId mrid)
private FileRepository	getFileRepository()
String	getTransactional()
String	getTypeName()
private void	initTransaction(ModuleRevisionId module)
boolean	isLocal()
private boolean	isTransactionStarted()
void	setLocal(boolean local)
void	setTransactional(String transactional)
boolean	supportTransaction()
private void	unsupportedTransaction(String msg)

Methods inherited from class org.apache.ivy.plugins.resolver.RepositoryResolver

download, dumpSettings, exist, findResourceUsingPattern, findTokenValues, get, getRepository, getResource, isAlwaysCheckExactRevision, listResources, listTokenValues, publish, put, putChecksum, putSignature, setAlwaysCheckExactRevision, setName, setRepository, setSettings, setSigner

Methods inherited from class org.apache.ivy.plugins.resolver.AbstractPatternsBasedResolver

convertM2CriteriaForResourceSearch, convertM2IdForResourceSearch, convertM2OrganizationForResourceSearch, convertM2ResourceSearchIdToNormal, convertM2TokenValuesForResourceSearch, findArtifactNames, findArtifactRef, findIvyFileRef, findIvyNames, findNames, findResource, findResourceUsingPatterns, getArtifactPatterns, getIvyPatterns, getModuleDescriptorExtension, isM2compatible, listTokenValues, setArtifactPatterns, setIvyPatterns, setM2compatible

Methods inherited from class org.apache.ivy.plugins.resolver.BasicResolver

acceptLatest, checkModuleDescriptorRevision, clearArtifactAttempts, clearIvyAttempts, doFindArtifactRef, download, exists, findFirstArtifactRef, getAndCheck, getArtifactRef, getChecksumAlgorithms, getDefaultRMDParser, getDependency, getPublicationDate, getRMDParser, getWorkspaceName, isAllownomd, isCheckconsistency, isEnvDependent, isForce, listModules, listOrganisations, listRevisions, listTokenValues, locate, logArtifactAttempt, logAttempt, logIvyAttempt, parse, reportFailure, reportFailure, setAllownomd, setCheckconsistency, setChecksums, setDescriptor, setEnvDependent, setForce, setWorkspaceName, shouldReturnResolvedModule, toString

Methods inherited from class org.apache.ivy.plugins.resolver.AbstractResolver

checkInterrupted, checkLatest, doValidate, findModuleInCache, findModuleInCache, fromSystem, fromSystem, getCacheDownloadOptions, getCacheOptions, getChangingMatcherName, getChangingPattern, getDownloadOptions, getEventManager, getLatest, getLatestStrategy, getName, getNamespace, getParserSettings, getRepositoryCacheManager, getSettings, getSystemNode, getTimeoutConstraint, hidePassword, isAfter, isValidate, saveModuleRevisionIfNeeded, setCache, setChangingMatcher, setChangingPattern, setCheckmodified, setEventManager, setLatest, setLatestStrategy, setNamespace, setRepositoryCacheManager, setTimeoutConstraint, setValidate, toSystem, toSystem, toSystem, toSystem, toSystem, toSystem, validate

Methods inherited from class java.lang.Object

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

Field Details

TRANSACTION_DESTINATION_SUFFIX

private static final String TRANSACTION_DESTINATION_SUFFIX

See Also:

• Constant Field Values

TRANSACTION_PATTERN

private static final Pattern TRANSACTION_PATTERN

transactional

private String transactional

Transactional mode. auto: use transaction if possible, only log verbose message if not true: always use transaction, fail if not supported false: never use transactions

supportTransaction

private Boolean supportTransaction

When set indicates if this resolver supports transaction

baseTransactionPattern

private String baseTransactionPattern

The pattern leading to the directory where files are published before being moved at the end of a transaction

fullTransactionPatterns

private Map<String,String> fullTransactionPatterns

Map between actual patterns and patterns used during the transaction to put files in a temporary directory

transactionTempDir

private File transactionTempDir

Location where files are published during the transaction

transactionDestDir

private File transactionDestDir

Location where files should end up at the end of the transaction

Constructor Details

FileSystemResolver

public FileSystemResolver()

Method Details

getTypeName

public String getTypeName()

Overrides:

getTypeName in class RepositoryResolver

isLocal

public boolean isLocal()

setLocal

public void setLocal(boolean local)

getFileRepository

private FileRepository getFileRepository()

getDestination

protected String getDestination(String pattern,
 Artifact artifact,
 ModuleRevisionId mrid)

Overrides:

getDestination in class RepositoryResolver

isTransactionStarted

private boolean isTransactionStarted()

abortPublishTransaction

public void abortPublishTransaction()
                             throws IOException

Specified by:

abortPublishTransaction in interface DependencyResolver

Overrides:

abortPublishTransaction in class AbstractResolver

Throws:

IOException

commitPublishTransaction

public void commitPublishTransaction()
                              throws IOException

Specified by:

commitPublishTransaction in interface DependencyResolver

Overrides:

commitPublishTransaction in class AbstractResolver

Throws:

IOException

beginPublishTransaction

public void beginPublishTransaction(ModuleRevisionId module,
 boolean overwrite)
                             throws IOException

Specified by:

beginPublishTransaction in interface DependencyResolver

Overrides:

beginPublishTransaction in class AbstractResolver

Throws:

IOException

filterNames

protected Collection<String> filterNames(Collection<String> values)

Description copied from class: BasicResolver

Filters names before returning them in the findXXXNames or findTokenValues method.

Remember to call the super implementation when overriding this method.

Overrides:

filterNames in class BasicResolver

Parameters:

values - the list to filter.

Returns:

the filtered list

supportTransaction

public boolean supportTransaction()

closeTransaction

private void closeTransaction()

checkSupportTransaction

private void checkSupportTransaction()

unsupportedTransaction

private void unsupportedTransaction(String msg)

initTransaction

private void initTransaction(ModuleRevisionId module)

getTransactional

public String getTransactional()

setTransactional

public void setTransactional(String transactional)

addConfiguredIvy

public void addConfiguredIvy(IvyPattern p)

Overrides:

addConfiguredIvy in class AbstractPatternsBasedResolver

addIvyPattern

public void addIvyPattern(String pattern)

Description copied from class: AbstractPatternsBasedResolver

example of pattern : ~/Workspace/[module]/[module].ivy.xml

Overrides:

addIvyPattern in class AbstractPatternsBasedResolver

Parameters:

pattern - String

addConfiguredArtifact

public void addConfiguredArtifact(IvyPattern p)

Overrides:

addConfiguredArtifact in class AbstractPatternsBasedResolver

addArtifactPattern

public void addArtifactPattern(String pattern)

Overrides:

addArtifactPattern in class AbstractPatternsBasedResolver