*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.publish.metadata
Class DavBinaryPackage

com.sas.services.publish.metadata.DavBinaryPackage

All Implemented Interfaces:

ContentInterface, MetadataInterface, PublicObjectInterface, DavBinaryPackageInterface, PackageInterface, java.io.Serializable, java.rmi.Remote

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public class DavBinaryPackage
implements DavBinaryPackageInterface

DAV implementation of a PackageInterface (DAVBinaryPackageInterface) for a binary package.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.services.information.metadata.Metadata

_actionInterfaces, _children, _isCompatible, _isDestroyPending, _isReadCompatible, _myRefreshInterval, _myState, _omrCreateDate, _omrModifyDate, _repository, _repositoryFlag, _repositoryObject, _treeRefreshTime, formats, gmtZone, OMSOBJ_STRING, REPOSITORY_DAV, REPOSITORY_LOMR, REPOSITORY_NONE, REPOSITORY_OMR, SLASH

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Constructor Summary

DavBinaryPackage()
Creates a new DAVBinarypackage

DavBinaryPackage(DAVBinarypackage o)
Creates a new DAVBinarypackage that incorporates the DAV binary package object passed to the constructor

Method Summary

java.lang.String	getAbstract() Return the abstract.
ChannelInterface	getChannel() Get the Channel that this archive belongs to, if any.
ContentDestination	getContentDestination() Get the ContentDestination that represents the archive path information.
long	getCreationDate() Get the date the package was created.
java.lang.String	getCreationDateString() Get a formatted string representing the date and time the package was created.
java.lang.String	getDescription() Return the description.
java.lang.String	getDisplayDescription() Get the display description for this object.
java.lang.String	getDisplayName() Get the display name for this object.
long	getExpirationDate() Get the expiration date of the package.
java.lang.String	getExpirationDateString() Get the expiration date of the package.
AttributeMapInterface	getProperties() Get the name/value pairs for this package.
PersonInterface	getPublisher() Get a com.sas.services.information.metadata.Person object which represents the publisher of the package.
java.lang.String	getPublisherAlias() Get the alias for the publisher.
java.lang.String	getType() Get the smartobject type - this is a "content" provider
boolean	isExpired() Determines if the package has expired.
java.lang.Object	newServiceObject() For objects that support it, get an "active" interface for the metadata object.
EventDataInterface	publish(ResultPackageInterface rPkg, java.io.InputStream inputStream) Publishes the result package to the DAV binarypackage entity.
void	setDescription(java.lang.String description) Set the object description.
void	setName(java.lang.String name) Set the name of the object.

Methods inherited from class com.sas.services.information.metadata.Content

getContentAsBytes, getContentAsStream, getContentAsString, getContentType, getProperty, setContent, setContentFromBytes, setContentFromStream, setContentType, setProperty

Methods inherited from class com.sas.services.information.metadata.Metadata

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addProcessorInterface, addPrompt, addPropertySet, addRemark, addResponsibleParty, addToList, addTransactionListener, addUsedByPrototype, checkin, checkout, checkPulse, clearInformationService, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, deleteRootObject, destroy, fromByteArray, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getContainer, getCreateDate, getCreatedBy, getDefaultLocalizableProperties, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentifier, getIdentities, getImplementors, getInformationService, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getName, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getObjectURI, getParent, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getProcessorInterface, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getTreeRefresh, getTypeDescriptor, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, hashCode, isAuthorized, isCompatible, isConnectionException, isDeleted, isDestroyed, isLoggingEnabled, isObjectAlive, isReadCompatible, logFormat, logFormat, logFormat, logFormat, logMessage, logMessage, logThrowable, mapNameToFilesystem, mapUrlToFilesystem, moveTo, notifyTransactionListeners, refresh, removeAccessControl, removeDocument, removeExtension, removeFromList, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, reset, rollback, setAttribute, setAttributes, setCompatibility, setDefaultLocalizableProperties, setDeleted, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setTreeRefresh, setUsingPrototype, startTransaction, toByteArray, toString, transactionEvent, uncheckout, update, updateFromBag, validateNameAndFolder, validateNameAndFolder, version

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor

Constructor Detail

DavBinaryPackage

public DavBinaryPackage()
                 throws java.rmi.RemoteException

Creates a new DAVBinarypackage

Throws:

java.rmi.RemoteException - if unable to export the remote object to the RMI system.

DavBinaryPackage

public DavBinaryPackage(DAVBinarypackage o)
                 throws java.rmi.RemoteException

Creates a new DAVBinarypackage that incorporates the DAV binary package object passed to the constructor

Throws:

java.rmi.RemoteException - if unable to export the remote object to the RMI system.

Method Detail

getType

public java.lang.String getType()
                         throws java.rmi.RemoteException

Description copied from class: Content

Get the smartobject type - this is a "content" provider

Specified by:

getType in interface MetadataInterface

Overrides:

getType in class Content

Returns:

A type string for the object.

Throws:

java.rmi.RemoteException - in the case of network failures

setName

public void setName(java.lang.String name)
             throws java.rmi.RemoteException

Description copied from class: Metadata

Set the name of the object.

Specified by:

setName in interface MetadataInterface

Overrides:

setName in class Metadata

Parameters:

name - The name of the object in the repository.

Throws:

java.rmi.RemoteException - in the event of remote object failure.

setDescription

public void setDescription(java.lang.String description)
                    throws java.rmi.RemoteException

Description copied from class: Metadata

Set the object description.

Specified by:

setDescription in interface MetadataInterface

Overrides:

setDescription in class Metadata

Parameters:

description - The description String for the object.

Throws:

java.rmi.RemoteException - in the event of remote object failure.

getCreationDate

public long getCreationDate()
                     throws java.rmi.RemoteException

Description copied from interface: PackageInterface

Get the date the package was created.

Specified by:

getCreationDate in interface PackageInterface

Returns:

The package creation date and time.

Throws:

java.rmi.RemoteException - In the event of remote object failure.

getCreationDateString

public java.lang.String getCreationDateString()
                                       throws java.rmi.RemoteException

Description copied from interface: PackageInterface

Get a formatted string representing the date and time the package was created.

Specified by:

getCreationDateString in interface PackageInterface

Returns:

A string representing the date the package was created.

Throws:

java.rmi.RemoteException - In the event of remote object failure.

getExpirationDate

public long getExpirationDate()
                       throws java.rmi.RemoteException

Description copied from interface: PackageInterface

Get the expiration date of the package.

Specified by:

getExpirationDate in interface PackageInterface

Returns:

The date and time the package expires and the data it contains should be considered obsolete.

Throws:

java.rmi.RemoteException - In the event of remote object failure.

getExpirationDateString

public java.lang.String getExpirationDateString()
                                         throws java.rmi.RemoteException

Description copied from interface: PackageInterface

Get the expiration date of the package. The date is returned as a formatted string.

Specified by:

getExpirationDateString in interface PackageInterface

Returns:

The date and time the package expires and the data it contains should be considered obsolete.

Throws:

java.rmi.RemoteException - In the event of remote object failure.

getAbstract

public java.lang.String getAbstract()
                             throws java.rmi.RemoteException

Return the abstract. This routine strips off any quotes. Quotes are added by the publish framework at publish time and so should be stripped.

Specified by:

getAbstract in interface PackageInterface

Returns:

String The package abstract

Throws:

java.rmi.RemoteException - in the event of remote object failure.

getProperties

public AttributeMapInterface getProperties()
                                    throws java.rmi.RemoteException

Description copied from interface: PackageInterface

Get the name/value pairs for this package.

Specified by:

getProperties in interface PackageInterface

Returns:

A Map of name/value pairs that describe this package.

Throws:

java.rmi.RemoteException - In the event of remote object failure.

getChannel

public ChannelInterface getChannel()
                            throws ServiceException,
                                   java.rmi.RemoteException

Description copied from interface: PackageInterface

Get the Channel that this archive belongs to, if any.

Specified by:

getChannel in interface PackageInterface

Returns:

The Channel that this package was published under.

Throws:

ServiceException - If a repository or service level error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getPublisher

public PersonInterface getPublisher()
                             throws java.rmi.RemoteException

Get a com.sas.services.information.metadata.Person object which represents the publisher of the package.

Specified by:

getPublisher in interface PackageInterface

Returns:

The Person who published the package.

Throws:

java.rmi.RemoteException - in the event of remote object failure.

getPublisherAlias

public java.lang.String getPublisherAlias()
                                   throws java.rmi.RemoteException

Get the alias for the publisher. This String is in the form of "userAccountName" "personName". The first quoted value is the proccess id (name) of the publisher. This is followed by a space, and then another quoted value which is the name of the person that published the package. If the name of the person was not available, this second quoted value will be the user name used to publish the package.

Specified by:

getPublisherAlias in interface PackageInterface

Returns:

A String containing the publisher alias information.

Throws:

java.rmi.RemoteException - in the event of remote object failure.

newServiceObject

public java.lang.Object newServiceObject()
                                  throws ServiceException,
                                         java.rmi.RemoteException

Description copied from class: Metadata

For objects that support it, get an "active" interface for the metadata object. For instance, com.sas.services.information.metadata.StoredProcess returns a com.sas.services.storedProcess.StoredProcess object.

Specified by:

newServiceObject in interface MetadataInterface

Overrides:

newServiceObject in class Metadata

Returns:

The "active" object for this metadata.

Throws:

ServiceException - if an error occurs

java.rmi.RemoteException - in the event of remote object failure

getContentDestination

public ContentDestination getContentDestination()
                                         throws java.rmi.RemoteException

Get the ContentDestination that represents the archive path information.

Specified by:

getContentDestination in interface PackageInterface

Returns:

A ContentDestination which has the file system or server information.

Throws:

java.rmi.RemoteException - in the event of a remote object failure.

publish

public EventDataInterface publish(ResultPackageInterface rPkg,
                                  java.io.InputStream inputStream)
                           throws ServiceException,
                                  java.rmi.RemoteException

Publishes the result package to the DAV binarypackage entity.

Specified by:

publish in interface DavBinaryPackageInterface

Parameters:

rPkg - The result package to be published

inputStream - The stream representing the archive binary

Returns:

EventDataInterface Containg the SAS package event data

Throws:

java.rmi.RemoteException - in the event of remote object failure.

ServiceException - in the event of a publish failure.

getDescription

public java.lang.String getDescription()

Return the description. This overrides getDescription() in com.sas.services.information.metadata.dav.DAVPackage. When a package is published, the publish transports quote the description value as specified by the user. Because of this, we need to strip off any quotes before returning to the user.

Specified by:

getDescription in interface MetadataInterface

Overrides:

getDescription in class Metadata

Returns:

String The package description

getDisplayName

public java.lang.String getDisplayName()
                                throws ServiceException,
                                       java.rmi.RemoteException

Get the display name for this object.

Specified by:

getDisplayName in interface PackageInterface

Returns:

The object display name.

Throws:

ServiceException - If a repository or service level error occurs.

java.rmi.RemoteException - if an error occurs

getDisplayDescription

public java.lang.String getDisplayDescription()
                                       throws ServiceException,
                                              java.rmi.RemoteException

Get the display description for this object.

Specified by:

getDisplayDescription in interface PackageInterface

Returns:

The object display description.

Throws:

ServiceException - If a repository or service level error occurs.

java.rmi.RemoteException - if an error occurs

isExpired

public boolean isExpired()
                  throws java.rmi.RemoteException,
                         ServiceException

Determines if the package has expired. The expiration datetime is compared with the current datetime when this method is invoked.

Specified by:

isExpired in interface PackageInterface

Returns:

true if the package has expired; otherwise false

Throws:

ServiceException - If a repository or service level error occurs.

java.rmi.RemoteException - if an error occurs

*** This class provides Binary Compatibility only, not Source Compatibility ***