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

com.sas.services.publish.metadata
Class DavBinaryPackage

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.sas.services.information.metadata.Metadata
                          |
                          +--com.sas.services.information.metadata.Content
                                |
                                +--com.sas.services.publish.metadata.DavBinaryPackage

All Implemented Interfaces:

ContentInterface, DavBinaryPackageInterface, MetadataInterface, PackageInterface,

public class DavBinaryPackage

extends Content

implements DavBinaryPackageInterface

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

Since:

1.0

See Also:

Serialized Form

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

_repository, _repositoryFlag, _repositoryObject, formats, gmtZone, REPOSITORY_DAV, REPOSITORY_LDAP, REPOSITORY_NONE, REPOSITORY_OMR

Fields inherited from class java.rmi.server.RemoteObject

ref

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

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

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.
String	getCreationDateString() Get a formatted string representing the date and time the package was created.
String	getDescription() Return the description.
long	getExpirationDate() Get the expiration date of the package.
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.
String	getPublisherAlias() Get the alias for the publisher.
String	getType() Get the object type.
Object	newServiceObject() For objects that support it, get an "active" interface for the metadata object.
EventDataInterface	publish(ResultPackageInterface rPkg, InputStream inputStream) Publishes the result package to the DAV binarypackage entity.
void	setDescription(String description) Sets the description for this object.
void	setName(String name) Set this object's name.

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, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, clearInformationService, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getInformationService, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getTreeRefresh, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, notifyTransactionListeners, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setGUID, setKeywords, setPermission, setRemarksList, setRepository, setTreeRefresh, startTransaction, transactionEvent, uncheckout, update, version

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setGUID, setKeywords, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Constructor Detail

DavBinaryPackage

public DavBinaryPackage()
                 throws RemoteException

Creates a new DAVBinarypackage

Throws:

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

DavBinaryPackage

public DavBinaryPackage(DAVBinarypackage o)
                 throws RemoteException

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

Throws:

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

Method Detail

getType

public String getType()
               throws RemoteException

Description copied from interface: MetadataInterface

Get the object type. Subclasses of Metadata will return a repository-neutral type string. If no subclass exists, Metadata returns the repository-specific type.

Specified by:

getType in interface MetadataInterface

Overrides:

getType in class Content

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Returns:

A type string for the object.

Throws:

RemoteException - if an error occurs

setName

public void setName(String name)
             throws RemoteException

Description copied from interface: MetadataInterface

Set this object's name.

Specified by:

setName in interface MetadataInterface

Overrides:

setName in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Parameters:

name - a String for the object name.

Throws:

RemoteException - if an error occurs

setDescription

public void setDescription(String description)
                    throws RemoteException

Description copied from interface: MetadataInterface

Sets the description for this object.

Specified by:

setDescription in interface MetadataInterface

Overrides:

setDescription in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Parameters:

description - The object description.

Throws:

RemoteException - if an error occurs

getCreationDate

public long getCreationDate()
                     throws RemoteException

Description copied from interface: PackageInterface

Get the date the package was created.

Specified by:

getCreationDate in interface PackageInterface

Following copied from interface: com.sas.services.publish.metadata.PackageInterface

Returns:

The package creation date and time.

getCreationDateString

public String getCreationDateString()
                             throws 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

Following copied from interface: com.sas.services.publish.metadata.PackageInterface

Returns:

A string representing the date the package was created.

getExpirationDate

public long getExpirationDate()
                       throws RemoteException

Description copied from interface: PackageInterface

Get the expiration date of the package.

Specified by:

getExpirationDate in interface PackageInterface

Following copied from interface: com.sas.services.publish.metadata.PackageInterface

Returns:

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

getExpirationDateString

public String getExpirationDateString()
                               throws 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

Following copied from interface: com.sas.services.publish.metadata.PackageInterface

Returns:

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

getAbstract

public String getAbstract()
                   throws 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:

RemoteException - in the event of remote object failure.

getProperties

public AttributeMapInterface getProperties()
                                    throws RemoteException

Description copied from interface: PackageInterface

Get the name/value pairs for this package.

Specified by:

getProperties in interface PackageInterface

Following copied from interface: com.sas.services.publish.metadata.PackageInterface

Returns:

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

getChannel

public ChannelInterface getChannel()
                            throws ServiceException,
                                   RemoteException

Description copied from interface: PackageInterface

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

Specified by:

getChannel in interface PackageInterface

getPublisher

public PersonInterface getPublisher()
                             throws 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:

RemoteException - in the event of remote object failure.

getPublisherAlias

public String getPublisherAlias()
                         throws 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:

RemoteException - in the event of remote object failure.

newServiceObject

public Object newServiceObject()
                        throws ServiceException,
                               RemoteException

Description copied from interface: MetadataInterface

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

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Returns:

The "active" object for this metadata.

Throws:

ServiceException - if an error occurs

RemoteException - if an error occurs

getContentDestination

public ContentDestination getContentDestination()
                                         throws 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:

RemoteException - in the event of a remote object failure.

publish

public EventDataInterface publish(ResultPackageInterface rPkg,
                                  InputStream inputStream)
                           throws ServiceException,
                                  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:

RemoteException - in the event of remote object failure.

ServiceException - in the event of a publish failure.

getDescription

public 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

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