Package org.eclipse.aether.internal.impl

Class DefaultUpdateCheckManager

java.lang.Object

org.eclipse.aether.internal.impl.DefaultUpdateCheckManager

All Implemented Interfaces:

UpdateCheckManager, Service

@Singleton
@Named
public class DefaultUpdateCheckManager
extends Object
implements UpdateCheckManager, Service

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	CONFIG_PROP_SESSION_STATE
private static final String	ERROR_KEY_SUFFIX
private static final org.slf4j.Logger	LOGGER
private static final String	NOT_FOUND
(package private) static final Object	SESSION_CHECKS
private static final int	STATE_BYPASS
private static final int	STATE_DISABLED
private static final int	STATE_ENABLED
private TrackingFileManager	trackingFileManager
private static final long	TS_NEVER	This "last modified" timestamp is used when no local file is present, signaling "first attempt" to cache a file, but as it is not present, outcome is simply always "go get it".
private static final long	TS_UNKNOWN	This "last modified" timestamp is returned by getLastUpdated(Properties, String) method when the timestamp entry is not found (due properties file not present or key not present in properties file, irrelevant).
private static final String	UPDATED_KEY_SUFFIX
private UpdatePolicyAnalyzer	updatePolicyAnalyzer

Constructor Summary

Constructors

Constructor	Description
DefaultUpdateCheckManager()	Deprecated.
DefaultUpdateCheckManager(TrackingFileManager trackingFileManager, UpdatePolicyAnalyzer updatePolicyAnalyzer)

Method Summary

Modifier and Type	Method	Description
void	checkArtifact(RepositorySystemSession session, UpdateCheck<Artifact,ArtifactTransferException> check)	Checks whether an artifact has to be updated from a remote repository.
void	checkMetadata(RepositorySystemSession session, UpdateCheck<Metadata,MetadataTransferException> check)	Checks whether metadata has to be updated from a remote repository.
private File	getArtifactTouchFile(File artifactFile)
private static int	getCacheFlag(String error)
private String	getDataKey(File metadataFile)
private String	getDataKey(RemoteRepository repository)
private String	getError(Properties props, String key)
private long	getLastUpdated(Properties props, String key)
private File	getMetadataTouchFile(File metadataFile)
private String	getRepoKey(RepositorySystemSession session, RemoteRepository repository)
private int	getSessionState(RepositorySystemSession session)
private String	getTransferKey(RepositorySystemSession session, File metadataFile, RemoteRepository repository)
private String	getTransferKey(RepositorySystemSession session, RemoteRepository repository)
private String	getUpdateKey(RepositorySystemSession session, File file, RemoteRepository repository)
private boolean	hasErrors(Properties props)
void	initService(ServiceLocator locator)	Provides the opportunity to initialize this service and to acquire other services for its operation from the locator.
private boolean	isAlreadyUpdated(RepositorySystemSession session, Object updateKey)
private boolean	isUpdatedRequired(RepositorySystemSession session, long lastModified, String policy)
private ArtifactTransferException	newException(String error, Artifact artifact, RemoteRepository repository)
private MetadataTransferException	newException(String error, Metadata metadata, RemoteRepository repository)
private String	normalizeRepoUrl(String url)
private Properties	read(File touchFile)
DefaultUpdateCheckManager	setTrackingFileManager(TrackingFileManager trackingFileManager)
private void	setUpdated(RepositorySystemSession session, Object updateKey)
DefaultUpdateCheckManager	setUpdatePolicyAnalyzer(UpdatePolicyAnalyzer updatePolicyAnalyzer)
void	touchArtifact(RepositorySystemSession session, UpdateCheck<Artifact,ArtifactTransferException> check)	Updates the timestamp for the artifact contained in the update check.
void	touchMetadata(RepositorySystemSession session, UpdateCheck<Metadata,MetadataTransferException> check)	Updates the timestamp for the metadata contained in the update check.
private Properties	write(File touchFile, String dataKey, String transferKey, Exception error)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

trackingFileManager

private TrackingFileManager trackingFileManager

updatePolicyAnalyzer

private UpdatePolicyAnalyzer updatePolicyAnalyzer

UPDATED_KEY_SUFFIX

private static final String UPDATED_KEY_SUFFIX

See Also:

• Constant Field Values

ERROR_KEY_SUFFIX

private static final String ERROR_KEY_SUFFIX

See Also:

• Constant Field Values

NOT_FOUND

private static final String NOT_FOUND

See Also:

• Constant Field Values

SESSION_CHECKS

static final Object SESSION_CHECKS

CONFIG_PROP_SESSION_STATE

static final String CONFIG_PROP_SESSION_STATE

See Also:

• Constant Field Values

STATE_ENABLED

private static final int STATE_ENABLED

See Also:

• Constant Field Values

STATE_BYPASS

private static final int STATE_BYPASS

See Also:

• Constant Field Values

STATE_DISABLED

private static final int STATE_DISABLED

See Also:

• Constant Field Values

TS_NEVER

private static final long TS_NEVER

This "last modified" timestamp is used when no local file is present, signaling "first attempt" to cache a file, but as it is not present, outcome is simply always "go get it".

Its meaning is "we never downloaded it", so go grab it.

See Also:

• Constant Field Values

TS_UNKNOWN

private static final long TS_UNKNOWN

This "last modified" timestamp is returned by getLastUpdated(Properties, String) method when the timestamp entry is not found (due properties file not present or key not present in properties file, irrelevant). It means that the cached file (artifact or metadata) is present, but we cannot tell when was it downloaded. In this case, it is UpdatePolicyAnalyzer applying in-effect policy, that decide is update (re-download) needed or not. For example, if policy is "never", we should not re-download the file.

Its meaning is "we downloaded it, but have no idea when", so let the policy decide its fate.

See Also:

• Constant Field Values

Constructor Details

DefaultUpdateCheckManager

@Deprecated
public DefaultUpdateCheckManager()

Deprecated.

DefaultUpdateCheckManager

@Inject
public DefaultUpdateCheckManager(TrackingFileManager trackingFileManager,
 UpdatePolicyAnalyzer updatePolicyAnalyzer)

Method Details

initService

public void initService(ServiceLocator locator)

Description copied from interface: Service

Provides the opportunity to initialize this service and to acquire other services for its operation from the locator. A service must not save the reference to the provided service locator.

Specified by:

initService in interface Service

Parameters:

locator - The service locator, must not be null.

setTrackingFileManager

public DefaultUpdateCheckManager setTrackingFileManager(TrackingFileManager trackingFileManager)

setUpdatePolicyAnalyzer

public DefaultUpdateCheckManager setUpdatePolicyAnalyzer(UpdatePolicyAnalyzer updatePolicyAnalyzer)

checkArtifact

public void checkArtifact(RepositorySystemSession session,
 UpdateCheck<Artifact,ArtifactTransferException> check)

Description copied from interface: UpdateCheckManager

Checks whether an artifact has to be updated from a remote repository.

Specified by:

checkArtifact in interface UpdateCheckManager

Parameters:

session - The repository system session during which the request is made, must not be null.

check - The update check request, must not be null.

getCacheFlag

private static int getCacheFlag(String error)

newException

private ArtifactTransferException newException(String error,
 Artifact artifact,
 RemoteRepository repository)

checkMetadata

public void checkMetadata(RepositorySystemSession session,
 UpdateCheck<Metadata,MetadataTransferException> check)

Description copied from interface: UpdateCheckManager

Checks whether metadata has to be updated from a remote repository.

Specified by:

checkMetadata in interface UpdateCheckManager

Parameters:

session - The repository system session during which the request is made, must not be null.

check - The update check request, must not be null.

newException

private MetadataTransferException newException(String error,
 Metadata metadata,
 RemoteRepository repository)

getLastUpdated

private long getLastUpdated(Properties props,
 String key)

getError

private String getError(Properties props,
 String key)

getArtifactTouchFile

private File getArtifactTouchFile(File artifactFile)

getMetadataTouchFile

private File getMetadataTouchFile(File metadataFile)

getDataKey

private String getDataKey(RemoteRepository repository)

getTransferKey

private String getTransferKey(RepositorySystemSession session,
 RemoteRepository repository)

getDataKey

private String getDataKey(File metadataFile)

getTransferKey

private String getTransferKey(RepositorySystemSession session,
 File metadataFile,
 RemoteRepository repository)

getRepoKey

private String getRepoKey(RepositorySystemSession session,
 RemoteRepository repository)

normalizeRepoUrl

private String normalizeRepoUrl(String url)

getUpdateKey

private String getUpdateKey(RepositorySystemSession session,
 File file,
 RemoteRepository repository)

getSessionState

private int getSessionState(RepositorySystemSession session)

isAlreadyUpdated

private boolean isAlreadyUpdated(RepositorySystemSession session,
 Object updateKey)

setUpdated

private void setUpdated(RepositorySystemSession session,
 Object updateKey)

isUpdatedRequired

private boolean isUpdatedRequired(RepositorySystemSession session,
 long lastModified,
 String policy)

read

private Properties read(File touchFile)

touchArtifact

public void touchArtifact(RepositorySystemSession session,
 UpdateCheck<Artifact,ArtifactTransferException> check)

Description copied from interface: UpdateCheckManager

Updates the timestamp for the artifact contained in the update check.

Specified by:

touchArtifact in interface UpdateCheckManager

Parameters:

session - The repository system session during which the request is made, must not be null.

check - The update check request, must not be null.

hasErrors

private boolean hasErrors(Properties props)

touchMetadata

public void touchMetadata(RepositorySystemSession session,
 UpdateCheck<Metadata,MetadataTransferException> check)

Description copied from interface: UpdateCheckManager

Updates the timestamp for the metadata contained in the update check.

Specified by:

touchMetadata in interface UpdateCheckManager

Parameters:

session - The repository system session during which the request is made, must not be null.

check - The update check request, must not be null.

write

private Properties write(File touchFile,
 String dataKey,
 String transferKey,
 Exception error)