com.paypal.selion.grid.servlets.transfer

Interface ManagedArtifact

All Known Implementing Classes:

DefaultManagedArtifact

public interface ManagedArtifact

ManagedArtifact represents a basic artifact successfully saved to SeLion grid by an HTTP POST method call. All implementations MUST provide a default, no-argument constructor for the ManagedArtifact implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ManagedArtifact.RequestParameters Provides access to and/or represents the HTTP request parameters used by the @{link ManagedArtifact}

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARTIFACT_FILE_NAME
static String	ARTIFACT_FOLDER_NAME

Method Summary

Modifier and Type	Method and Description
String	getAbsolutePath() Return the path of the artifact file
byte[]	getArtifactContents() Returns the contents of the artifact as a byte array.
String	getArtifactName() Returns the artifact name.
String	getHttpContentType() Returns the MIME content type for this ManagedArtifact
<T extends ManagedArtifact.RequestParameters> T	getRequestParameters() Returns the headers associated with this ManagedArtifact
void	initFromPath(String absolutePath) Initialize the artifact by it's file path.
void	initFromUploadedArtifact(UploadedArtifact uploaded) Initialize the artifact by an in-bound uploaded artifact
boolean	isExpired() Returns true if this ManagedArtifact has expired.
boolean	matchesPathInfo(String pathInfo) Matches the artifact based on some path info.

Field Detail

ARTIFACT_FILE_NAME

static final String ARTIFACT_FILE_NAME

See Also:

Constant Field Values

ARTIFACT_FOLDER_NAME

static final String ARTIFACT_FOLDER_NAME

See Also:

Constant Field Values

Method Detail

initFromPath

void initFromPath(String absolutePath)

Initialize the artifact by it's file path.

Parameters:

absolutePath - absolute path to the artifact. Must be in the ServerRepository path. For example: /{serverRepository}/{artifactFolder}/{artifactName}

initFromUploadedArtifact

void initFromUploadedArtifact(UploadedArtifact uploaded)

Initialize the artifact by an in-bound uploaded artifact

Parameters:

uploaded - instance of UploadedArtifact which will contain the meta-info for the uploaded artifact

getArtifactName

String getArtifactName()

Returns the artifact name.

Returns:

Artifact name.

getArtifactContents

byte[] getArtifactContents()

Returns the contents of the artifact as a byte array. Called by the DownloadResponder

Returns:

Contents as a byte array.

matchesPathInfo

boolean matchesPathInfo(String pathInfo)

Matches the artifact based on some path info. Called by the ServerRepository to find artifacts by a relative, publicly exposed (via the download URL), path

Parameters:

pathInfo - String path information to match against. For example: /{artifactFolder}/{artifactName}

Returns:

true if there is a match, false otherwise.

getAbsolutePath

String getAbsolutePath()

Return the path of the artifact file

Returns:

the absolute path to the artifact file. Must include the ServerRepository path. For example: /{serverRepository}/{artifactFolder}/{artifactName}

isExpired

boolean isExpired()

Returns true if this ManagedArtifact has expired. Called by the ServerRepository to clean up artifacts.

Returns:

true if expired, false otherwise

getHttpContentType

String getHttpContentType()

Returns the MIME content type for this ManagedArtifact

Returns:

MIME content type

getRequestParameters

<T extends ManagedArtifact.RequestParameters> T getRequestParameters()

Returns the headers associated with this ManagedArtifact

Returns:

Instance of ManagedArtifact.RequestParameters