ProtocolHandler (Apache OODT 0.7 API)

java.lang.Object
- org.apache.oodt.cas.pushpull.protocol.ProtocolHandler

```
public class ProtocolHandler
extends Object
```
This class is responsible for creating the appropriate Protocol for the given RemoteSites. The boolean argument 'allowReuse' allows for one unique protocol for each URL. That is, if allowReuse is set to true, then if no Protocol has been created for the current site, the Protocol created will be saved and then returned for any later called with allowReuse equals true. This is to allow for the same Protocol object to be used by several classes. The Protocol class has been synchronized so this is thread-safe. If you set 'allowReuse' to false then a new Protocol object will be created and returned.

Author:

bfoster

Constructor Summary

Constructors
Constructor and Description
ProtocolHandler(ProtocolInfo pi)
Creates a new ProtocolHandler for the given Config object

Constructors
Constructor and Description
`ProtocolHandler(ProtocolInfo pi)` Creates a new ProtocolHandler for the given Config object

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cd(Protocol protocol, RemoteSiteFile file)`
`void`	`cdToHOME(Protocol protocol)`
`void`	`cdToROOT(Protocol protocol)`
`void`	`close()` Disconnects all waiting Protocols and clears the waiting lists.
`boolean`	`connect(Protocol protocol, RemoteSite remoteSite, boolean test)` Connects the given Protocol to the given URL
`boolean`	`delete(Protocol protocol, RemoteSiteFile file)`
`void`	`disconnect(Protocol protocol)` Disconnects and logs out the given Protocol
`void`	`download(Protocol protocol, RemoteSiteFile fromFile, File toFile, boolean delete)`
`String`	`getAbsPathFor(Protocol protocol, String path, boolean isDir)`
`Protocol`	`getAppropriateProtocol(RemoteSiteFile pFile, boolean allowReuse, boolean navigateToPathLoc)` Returns the appropriate protocol for the given Path
`Protocol`	`getAppropriateProtocolBySite(RemoteSite remoteSite, boolean allowReuse)`
`RemoteSiteFile`	`getHomeDir(RemoteSite site, Protocol protocol)`
`RemoteSiteFile`	`getProtocolFileFor(RemoteSite site, Protocol protocol, String file, boolean isDir)`
`boolean`	`isProtocolConnected(Protocol protocol)`
`List<RemoteSiteFile>`	`ls(Protocol protocol, RemoteSiteFile dir)`
`List<RemoteSiteFile>`	`ls(RemoteSite site, Protocol protocol)`
`List<RemoteSiteFile>`	`ls(RemoteSite site, Protocol protocol, ProtocolFileFilter filter)`
`List<RemoteSiteFile>`	`nextPage(RemoteSite site, Protocol protocol)`
`List<RemoteSiteFile>`	`nextPage(RemoteSite site, Protocol protocol, ProtocolFileFilter filter)`
`RemoteSiteFile`	`pwd(RemoteSite site, Protocol protocol)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ProtocolHandler
```
public ProtocolHandler(ProtocolInfo pi)
```
  Creates a new ProtocolHandler for the given Config object
  
  Parameters:
  config - The Config object that guides this ProtocolHandler in making class instanciations

Method Detail

getAppropriateProtocol
```
public Protocol getAppropriateProtocol(RemoteSiteFile pFile,
                              boolean allowReuse,
                              boolean navigateToPathLoc)
                                throws RemoteConnectionException
```
Returns the appropriate protocol for the given Path

Parameters:
ProtocolPath - Used to determine the appropriate Protocol to be returned and the path to navigate on if navigateToPathLoc is set to true.
allowReuse - Set to true if you would like ProtocolHandler to take care of the protocol returned (i.e. reuseable protocols may be returned by this method again, if it is the appropriate protocol type for a given Path. Also ProtocolHandler will take care of disconnecting the reuseable protocols)
navigateToPathLoc - If true, will navigate the to the end of the Path location specified

Returns:
Protocol for the given Path

Throws:

RemoteCommunicationException - If there is an error creating the protocol

RemoteConnectionException

getAppropriateProtocolBySite

public Protocol getAppropriateProtocolBySite(RemoteSite remoteSite,
                                    boolean allowReuse)
                                      throws ProtocolException

Throws:: ProtocolException

public List<RemoteSiteFile> nextPage(RemoteSite site,
                            Protocol protocol)
                              throws RemoteConnectionException,
                                     ProtocolException

Throws:: RemoteConnectionException; ProtocolException

public List<RemoteSiteFile> nextPage(RemoteSite site,
                            Protocol protocol,
                            ProtocolFileFilter filter)
                              throws RemoteConnectionException,
                                     ProtocolException

Parameters:: protocol -
Returns:
Throws:: RemoteConnectionException; ProtocolException

download

public void download(Protocol protocol,
            RemoteSiteFile fromFile,
            File toFile,
            boolean delete)
              throws RemoteConnectionException

Throws:: RemoteConnectionException

connect
```
public boolean connect(Protocol protocol,
              RemoteSite remoteSite,
              boolean test)
```
Connects the given Protocol to the given URL

Parameters:
protocol - The Protocol that will be connected
url - The server to which the Protocol will connect

Throws:

RemoteConnectionException - If connection fails

RemoteLoginException - If login fails

cdToROOT

public void cdToROOT(Protocol protocol)
              throws ProtocolException

Throws:: ProtocolException

cdToHOME

public void cdToHOME(Protocol protocol)
              throws ProtocolException

Throws:: ProtocolException

isProtocolConnected

public boolean isProtocolConnected(Protocol protocol)
                            throws ProtocolException

Throws:: ProtocolException

cd

public void cd(Protocol protocol,
      RemoteSiteFile file)
        throws ProtocolException

Throws:: ProtocolException

getProtocolFileFor

public RemoteSiteFile getProtocolFileFor(RemoteSite site,
                                Protocol protocol,
                                String file,
                                boolean isDir)
                                  throws ProtocolException

Throws:: ProtocolException

delete

public boolean delete(Protocol protocol,
             RemoteSiteFile file)
               throws MalformedURLException,
                      ProtocolException

Throws:: MalformedURLException; ProtocolException

pwd

public RemoteSiteFile pwd(RemoteSite site,
                 Protocol protocol)
                   throws ProtocolException

Throws:: ProtocolException

ls

public List<RemoteSiteFile> ls(Protocol protocol,
                      RemoteSiteFile dir)
                        throws ProtocolException

Throws:: ProtocolException

ls

public List<RemoteSiteFile> ls(RemoteSite site,
                      Protocol protocol)
                        throws ProtocolException

Throws:: ProtocolException

ls

public List<RemoteSiteFile> ls(RemoteSite site,
                      Protocol protocol,
                      ProtocolFileFilter filter)
                        throws ProtocolException

Throws:: ProtocolException

getHomeDir

public RemoteSiteFile getHomeDir(RemoteSite site,
                        Protocol protocol)

getAbsPathFor

public String getAbsPathFor(Protocol protocol,
                   String path,
                   boolean isDir)

disconnect
```
public void disconnect(Protocol protocol)
                throws RemoteConnectionException
```
Disconnects and logs out the given Protocol

Parameters:
protocol - The Protocol to be logout out and disconnected

Throws:

RemoteConnectionException

close
```
public void close()
           throws RemoteConnectionException
```
Disconnects all waiting Protocols and clears the waiting lists. Also clears the current Protocol

Throws:

RemoteConnectionException

Class ProtocolHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProtocolHandler

Method Detail

getAppropriateProtocol

getAppropriateProtocolBySite

nextPage

nextPage

download

connect

cdToROOT

cdToHOME

isProtocolConnected

cd

getProtocolFileFor

delete

pwd

ls

ls

ls

getHomeDir

getAbsPathFor

disconnect

close