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

com.sas.services.information.metadata
Class LdapDirectory

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.Folder
                                |
                                +--com.sas.services.information.metadata.LdapDirectory

All Implemented Interfaces:

DirectoryInterface, FolderInterface, MetadataInterface,

Direct Known Subclasses:

public class LdapDirectory

extends Folder

implements DirectoryInterface, java.io.Serializable

LDAP repository representation of a directory.

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

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

FOLDER_TYPE_BIP

Constructor Summary

	LdapDirectory()
protected	LdapDirectory(Class theClass) Constructs an instance using the specified class to determine appropriate RMI socket factories.
	LdapDirectory(RepositoryInterface repos, String name, FolderInterface parent)
protected	LdapDirectory(RepositoryInterface repos, String name, FolderInterface parent, Class theClass)
	LdapDirectory(Sasarchivepath o)
protected	LdapDirectory(Sasarchivepath o, Class theClass)
	LdapDirectory(Sasstoredprocesspath o)
protected	LdapDirectory(Sasstoredprocesspath o, Class theClass)

Method Summary

void	addFile(MetadataInterface file) Since a Directory object in LDAP has the information about files in it direcly under it, use the folder methods to get them.
void	addServer(MetadataInterface server) Add a server to the list that has access to this directory.
String	getFilePath() Return the path string for this directory.
List	getFiles() Get a list of files in this directory.
List	getServers() Get a list of servers that are associated with this directory.
String	getType() Get the object type.
boolean	isBasePath() Get flag indicating if this Directory is an HTTP server base path
boolean	isDavEnabled() Get flag indicating if this Directory is DAV enabled.
void	removeFile(MetadataInterface file) Use the folder method to remove a file since it should be a child of the path object.
void	removeServer(MetadataInterface server) Remove a server from the list that has access to this Directory.
void	setIsBasePath(boolean value) Set the flag indicating if this Directory is a valid base for an HTTP server.
void	setIsDavEnabled(boolean value) Set the flag indicating if this directory is DAV enabled.
void	setPath(String path) Set the path string for the directory.

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

addItem, addNewItem, addSubfolder, delete, deleteItem, deleteSubfolder, getFolderRefresh, getFolderType, getItem, getItemByClass, getItemByType, getItemRefresh, getItems, getItemsByClass, getItemsByType, getParent, getPath, getSubfolder, getSubfolders, makeSubfolder, mapNameToFilesystem, mapUrlToFilesystem, removeItem, removeSubfolder, setFolderRefresh, setFolderType, setItemRefresh, setName, setRepository

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

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, clearInformationService, commit, copyTo, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, 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, moveTo, newServiceObject, notifyTransactionListeners, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setPermission, setRemarksList, 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, getDescription, 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, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Constructor Detail

LdapDirectory

public LdapDirectory()
              throws RemoteException

LdapDirectory

protected LdapDirectory(Class theClass)
                 throws RemoteException

Constructs an instance using the specified class to determine appropriate RMI socket factories.

Parameters:

theClass - Class which will be used to determine the appropriate RMI socket factories.

Throws:

RemoteException - if unable to export the remote object.

LdapDirectory

protected LdapDirectory(Sasarchivepath o,
                        Class theClass)
                 throws RemoteException

LdapDirectory

protected LdapDirectory(Sasstoredprocesspath o,
                        Class theClass)
                 throws RemoteException

LdapDirectory

protected LdapDirectory(RepositoryInterface repos,
                        String name,
                        FolderInterface parent,
                        Class theClass)
                 throws RemoteException

LdapDirectory

public LdapDirectory(Sasarchivepath o)
              throws RemoteException

LdapDirectory

public LdapDirectory(Sasstoredprocesspath o)
              throws RemoteException

LdapDirectory

public LdapDirectory(RepositoryInterface repos,
                     String name,
                     FolderInterface parent)
              throws RemoteException

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 Folder

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

Returns:

A type string for the object.

Throws:

RemoteException - if an error occurs

getFilePath

public String getFilePath()
                   throws ServiceException,
                          RemoteException

Description copied from interface: DirectoryInterface

Return the path string for this directory.

Specified by:

getFilePath in interface DirectoryInterface

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

Returns:

The path.

Throws:

ServiceException - if a repository error occurs

RemoteException - in the event of remote object failure.

setPath

public void setPath(String path)
             throws ServiceException,
                    RemoteException

Description copied from interface: DirectoryInterface

Set the path string for the directory.

Specified by:

setPath in interface DirectoryInterface

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

Parameters:

path - The new path string.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

getFiles

public List getFiles()
              throws ServiceException,
                     RemoteException

Description copied from interface: DirectoryInterface

Get a list of files in this directory. Of course, this is a list of files that appear in the metadata repository, not necessarily what's on the file system.

Specified by:

getFiles in interface DirectoryInterface

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

Returns:

A List of MetadataInterface objects representing the files that are in the directory. Some may be Archives, but others may not be.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

addFile

public void addFile(MetadataInterface file)
             throws ServiceException,
                    RemoteException

Since a Directory object in LDAP has the information about files in it direcly under it, use the folder methods to get them.

Specified by:

addFile in interface DirectoryInterface

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

Parameters:

file - a new file to add to this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

removeFile

public void removeFile(MetadataInterface file)
                throws ServiceException,
                       RemoteException

Use the folder method to remove a file since it should be a child of the path object.

Specified by:

removeFile in interface DirectoryInterface

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

Parameters:

file - A file to remove.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of a remote object failure.

getServers

public List getServers()
                throws ServiceException,
                       RemoteException

Description copied from interface: DirectoryInterface

Get a list of servers that are associated with this directory. Hopefully, this association means that the server are able to access the contents of the directory.

Specified by:

getServers in interface DirectoryInterface

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

Returns:

A List of Server objects that are defined to have access to the contents of this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

addServer

public void addServer(MetadataInterface server)
               throws ServiceException,
                      RemoteException

Description copied from interface: DirectoryInterface

Add a server to the list that has access to this directory.

Specified by:

addServer in interface DirectoryInterface

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

Parameters:

server - A new server to add to the list for this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

removeServer

public void removeServer(MetadataInterface server)
                  throws ServiceException,
                         RemoteException

Description copied from interface: DirectoryInterface

Remove a server from the list that has access to this Directory.

Specified by:

removeServer in interface DirectoryInterface

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

Parameters:

server - A server to remove from the list that can access this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

isBasePath

public boolean isBasePath()
                   throws RemoteException

Get flag indicating if this Directory is an HTTP server base path

Specified by:

isBasePath in interface DirectoryInterface

Returns:

true if this is a valid base path for an HTTP server.

Throws:

RemoteException - in the event of remote object failure.

setIsBasePath

public void setIsBasePath(boolean value)
                   throws RemoteException

Set the flag indicating if this Directory is a valid base for an HTTP server.

Specified by:

setIsBasePath in interface DirectoryInterface

Parameters:

value - true if this Directory can be used by an HTTP server as a base.

Throws:

RemoteException - in the event of remote object failure.

isDavEnabled

public boolean isDavEnabled()
                     throws RemoteException

Get flag indicating if this Directory is DAV enabled.

Specified by:

isDavEnabled in interface DirectoryInterface

Returns:

true if this Directory supports DAV access.

Throws:

RemoteException - in the event of remote object failure.

setIsDavEnabled

public void setIsDavEnabled(boolean value)
                     throws RemoteException

Set the flag indicating if this directory is DAV enabled.

Specified by:

setIsDavEnabled in interface DirectoryInterface

Parameters:

value - true if this directory can be accessed via the DAV protocol.

Throws:

RemoteException - in the event of remote object failure.

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