jp.go.aist.dmrc.platform.beans.io.protocol

クラス PFWebdavClient

java.lang.Object

jp.go.aist.dmrc.platform.beans.io.protocol.PFWebdavClient

すべての実装されたインタフェース:

java.io.Serializable, PFComponent

public class PFWebdavClient
extends java.lang.Object
implements PFComponent

バージョン:

1.01

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PFWebdavClient() デフォルトコンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addSubDirectoriesTree(PFObjectTreeNode parent) 指定のノードの直下に存在するディレクトリのノードを追加します。
void	addSubDirectoriesTree(PFObjectTreeNode parent, java.lang.String temp) 指定のノードの直下に存在するディレクトリのノードを追加します。
void	addSubDirectoriesTree(PFObjectTreeNode parent, java.lang.String dest, java.lang.String temp) 指定のノードの直下に存在するディレクトリのノードを追加します。
boolean	connect() 接続する。
boolean	connect(java.lang.String uri) 接続する。
boolean	connect(java.lang.String uri, java.lang.String uid, java.lang.String pwd) 接続する。
boolean	copy(java.lang.String resource, java.lang.String dest) ファイル・ディレクトリをコピーします。
boolean	copyDirectory(java.lang.String resource, java.lang.String dest) ディレクトリを同名でコピーします。
boolean	copyDirectoryReserve(java.lang.String resource, java.lang.String dest) ディレクトリをコピーします。
boolean	copyFile(java.lang.String resource, java.lang.String dest) ファイルを同名でコピーします。
boolean	copyFileReserve(java.lang.String resource, java.lang.String dest) ファイルをコピーします。
boolean	copyReserve(java.lang.String resource, java.lang.String dest) ファイル・ディレクトリをコピーする。
boolean	delete(java.lang.String dest) 指定のファイル・ディレクトリを削除します。
boolean	deleteDirectory(java.lang.String dest) 指定のディレクトリを削除します。
boolean	deleteFile(java.lang.String dest) 指定のファイルを削除します。
boolean	disconnect() 接続を切断します。
boolean	get(java.lang.String resource, java.lang.String dest) サーバから、ファイル・ディレクトリを同名でダウンロードします。
PFObjectTree	getAllDirectoriesTree(java.lang.String dest) パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。
PFObjectTree	getAllDirectoriesTreeMulti(java.lang.String dest) パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
boolean	getDirectory(java.lang.String resource, java.lang.String dest) サーバから、ディレクトリを同名でダウンロードする。
java.lang.String	getDirectoryLastModified(java.lang.String dest) 指定のディレクトリの最終更新日付を取得します。
long	getDirectoryLength(java.lang.String dest) 指定のディレクトリサイズを取得します。
boolean	getDirectoryReserve(java.lang.String resource, java.lang.String dest) サーバから、ディレクトリをダウンロードする。
boolean	getFile(java.lang.String resource, java.lang.String dest) サーバから、ファイルを同名でダウンロードします。
java.lang.String	getFileLastModified(java.lang.String dest) 指定のファイルの最終更新日付を取得します。
long	getFileLength(java.lang.String dest) 指定のファイルサイズを取得します。
boolean	getFileReserve(java.lang.String resource, java.lang.String dest) サーバから、ファイルをダウンロードします。
java.lang.String	getHost() クライアントがアクセスしているホスト名を取得する。
java.lang.String	getLastModified(java.lang.String dest) 指定のファイル・ディレクトリの最終更新日付を取得します。
long	getLength(java.lang.String dest) 指定のファイル・ディレクトリサイズを取得します。
PFObjectList	getLockInfo(java.lang.String dest) ファイル・ディレクトリにかかっている排他ロック情報を取得します。
java.lang.String	getPath() パスを取得します。
int	getPort() クライアントがアクセスしているポートを取得します。
boolean	getReserve(java.lang.String resource, java.lang.String dest) サーバから、ファイル・ディレクトリをダウンロードをダウンロードする。
java.lang.String	getRoots() ルートパスを取得。
int	getStatusCode() 処理結果ステータスを取得する。
java.lang.String	getStatusMessage() 処理結果メッセージを取得する。
PFObjectTreeNode	getSubDirectoriesNode(java.lang.String dest, java.lang.String temp) 指定のパスでノードを作成し、その直下に存在するディレクトリを追加したものを取得します。
PFObjectList	getSubDirectoriesNodeList(java.lang.String dest, java.lang.String temp) 指定のパスの直下に存在するノードのリストを取得します。
java.lang.String	getURI() 接続先URIを取得する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isConnect() 接続を判定します。
boolean	isDirectory(java.lang.String resource) ディレクトリかどうかチェックします。
boolean	isExists(java.lang.String resource) 存在しているファイル・ディレクトリかどうかチェックします。
boolean	isExistsDirectory(java.lang.String resource) 存在しているディレクトリかどうかチェックします。
boolean	isExistsFile(java.lang.String resource) 存在しているファイルかどうかチェックします。
boolean	isFile(java.lang.String resource) ファイルかどうかチェックします。
boolean	isHidden(java.lang.String resource) 隠しファイル・ディレクトリかどうかチェックします。
boolean	isLocked(java.lang.String resource) ロックがかかっているファイル・ディレクトリかどうかチェックします。
boolean	isOverwrite() 読み取り属性を判定する。
PFObjectList	list(java.lang.String dest) 指定直下のファイル・ディレクトリ名称を取得します。
PFObjectList	listSubDirectoryNames(java.lang.String dest) 指定したディレクトリ直下に存在するディレクトリ名称の配列を取得します。
PFObjectList	listSubFileNames(java.lang.String dest) 指定したディレクトリ直下に存在するファイル名称の配列を取得します。
void	localeUpdated() ロケール変更に対応する。
boolean	lock(java.lang.String dest, java.lang.String owner) ファイル・ディレクトリを排他ロックする。
boolean	lock(java.lang.String dest, java.lang.String owner, int timeout) ファイル・ディレクトリを排他ロックする。
boolean	lockFile(java.lang.String dest, java.lang.String owner) ファイルを排他ロックする。
boolean	lockFile(java.lang.String dest, java.lang.String owner, int timeout) ファイルを排他ロックする。
boolean	mkdir(java.lang.String dest) 指定のディレクトリをサーバ上に作成する。
boolean	move(java.lang.String resource, java.lang.String dest) ファイル・ディレクトリを移動します。
boolean	moveDirectory(java.lang.String resource, java.lang.String dest) ディレクトリを同名で移動します。
boolean	moveDirectoryReserve(java.lang.String resource, java.lang.String dest) ディレクトリを移動します。
boolean	moveFile(java.lang.String resource, java.lang.String dest) ファイルを同名で移動します。
boolean	moveFileReserve(java.lang.String resource, java.lang.String dest) ファイルを移動します。
boolean	moveReserve(java.lang.String resource, java.lang.String dest) ファイル・ディレクトリを移動する。
boolean	put(java.lang.String dest, java.lang.String resource) ローカルファイル・ディレクトリを同名でサーバへアップロードする。
boolean	putNewFile(java.lang.String dest) サーバ上に新規ファイルを作成。
boolean	putReserve(java.lang.String dest, java.lang.String resource) ローカルファイル・ディレクトリをサーバへアップロードします。
boolean	releaseLock(java.lang.String dest) ファイル・ディレクトリにかかっている排他ロックを解除します。
boolean	releaseLockFile(java.lang.String dest) ファイルにかかっている排他ロックを解除します。
boolean	rename(java.lang.String resource, java.lang.String name) 指定のファイル・ディレクトリをリネームします。
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントのキー情報を設定する
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	setConnectionTimeout(int newTimeoutInMilliseconds) コネクションタイムアウトを設定する。
void	setLockDefaultTimeout(int timeout) タイムアウトまでの時間を設定する。
void	setOverwrite(boolean overwrite) 読み取り属性を設定する。
void	setPassword(java.lang.String pwd) パスワードを設定する。
void	setPath(java.lang.String dest) パスをURLに設定します。
void	setRootNodeName(java.lang.String nodeName) ツリーを作成するさいのルートノードの名称。
void	setURI(java.lang.String uri) 接続先URIを設定する。
void	setUserID(java.lang.String uid) ユーザIDを設定する。
void	setUserInfo(java.lang.String uid, java.lang.String pwd) ユーザID・パスワードを設定する。
boolean	stealLock(java.lang.String dest) ファイル・ディレクトリにかかっている排他ロックを自分のものにします。
boolean	unlock(java.lang.String dest, java.lang.String owner) ファイル・ディレクトリを排他ロックする。
boolean	unlockFile(java.lang.String dest, java.lang.String owner) ファイルを排他ロックする。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PFWebdavClient

public PFWebdavClient()

デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

関連項目:

PFComponent.getComponentName()

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー文字列

関連項目:

PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントのキー情報を設定する

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - 設定するコンポーネントのキー

関連項目:

PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

関連項目:

PFComponent.getComponentID()

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

関連項目:

PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

コンポーネントの文字列表現を返す。

関連項目:

PFComponent.getComponentString()

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

localeUpdated インタフェース内 PFComponent

関連項目:

PFComponent.localeUpdated()

setRootNodeName

public void setRootNodeName(java.lang.String nodeName)

ツリーを作成するさいのルートノードの名称。

 注意事項
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用。

 

パラメータ:

nodeName - - ルートノードの名称。

setUserID

public void setUserID(java.lang.String uid)
               throws PFComponentException

ユーザIDを設定する。

 注意事項
 なし。

 

パラメータ:

uid - - ユーザID

例外:

PFComponentException - 例外発生。

setPassword

public void setPassword(java.lang.String pwd)
                 throws PFComponentException

パスワードを設定する。

 注意事項
 なし。

 

パラメータ:

pwd - - パスワード

例外:

PFComponentException - 例外発生。

setUserInfo

public void setUserInfo(java.lang.String uid,
                        java.lang.String pwd)
                 throws PFComponentException

ユーザID・パスワードを設定する。

 注意事項
 なし。

 

パラメータ:

uid - - ユーザID

pwd - - パスワード

例外:

PFComponentException - 例外発生。

setURI

public void setURI(java.lang.String uri)
            throws PFComponentException

接続先URIを設定する。

 注意事項
 なし。

 

パラメータ:

uri - - 接続先URI

例外:

PFComponentException - 例外発生。

getURI

public java.lang.String getURI()

接続先URIを取得する。

 注意事項
 なし。

 

戻り値:

uri - 接続先URI

例外:

PFComponentException - 例外発生。

connect

public boolean connect()
                throws PFComponentException

接続する。

 注意事項
 なし。

 

例外:

PFComponentException - 例外発生。

connect

public boolean connect(java.lang.String uri)
                throws PFComponentException

接続する。

 注意事項
 なし。

 

パラメータ:

uri - - 接続先URI

例外:

PFComponentException - 例外発生。

connect

public boolean connect(java.lang.String uri,
                       java.lang.String uid,
                       java.lang.String pwd)
                throws PFComponentException

接続する。

 注意事項
 なし。

 

パラメータ:

uri - - 接続先URI

uid - - ユーザID

pwd - - パスワード

例外:

PFComponentException - 例外発生。

isConnect

public boolean isConnect()

接続を判定します。

 注意事項
 なし。

 

戻り値:

処理結果ステータス。
true: connect, false: not connect

disconnect

public boolean disconnect()
                   throws PFComponentException

接続を切断します。

 注意事項
 接続時のみ切断します。
 すでに切断済みの場合も処理結果として true を返却します。

 

戻り値:

処理結果ステータス。
true: disconnect・not connect, false: 例外発生時。

例外:

PFComponentException - 例外発生。

setConnectionTimeout

public void setConnectionTimeout(int newTimeoutInMilliseconds)
                          throws PFComponentException

コネクションタイムアウトを設定する。

 注意事項
 なし。

 

パラメータ:

newTimeoutInMilliseconds - - Timeout in milliseconds.

例外:

PFComponentException - 例外発生。

getHost

public java.lang.String getHost()
                         throws PFComponentException

クライアントがアクセスしているホスト名を取得する。

 注意事項
 接続が開始されていない場合はnull。

 

戻り値:

クライアントがアクセスしているホスト名。

例外:

PFComponentException - 例外発生。

getPort

public int getPort()
            throws PFComponentException

クライアントがアクセスしているポートを取得します。

 注意事項
 なし。

 

戻り値:

クライアントがアクセスしているポート。

例外:

PFComponentException - 例外発生。

getStatusCode

public int getStatusCode()
                  throws PFComponentException

処理結果ステータスを取得する。

 注意事項
 なし。

 

戻り値:

ステータスコード。

例外:

PFComponentException - 例外発生。

getStatusMessage

public java.lang.String getStatusMessage()
                                  throws PFComponentException

処理結果メッセージを取得する。

 注意事項
 なし。

 

戻り値:

メッセージ。

例外:

PFComponentException - 例外発生。

putNewFile

public boolean putNewFile(java.lang.String dest)
                   throws PFComponentException

サーバ上に新規ファイルを作成。

例外:

PFComponentException

put

public boolean put(java.lang.String dest,
                   java.lang.String resource)
            throws PFComponentException

ローカルファイル・ディレクトリを同名でサーバへアップロードする。

 注意事項
 同名でアップロードをするため、アップロード先の指定には、
 親ディレクトリまでを指定します。
 ファイルかディレクトリを自動で判別します。

 

パラメータ:

dest - - アップロード先。(親ディレクトリまで。)

resource - - アップロード元。(名称まで。)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

putReserve

public boolean putReserve(java.lang.String dest,
                          java.lang.String resource)
                   throws PFComponentException

ローカルファイル・ディレクトリをサーバへアップロードします。

 注意事項
 アップロード先には、名称までを指定します。
 ファイルかディレクトリを自動で判別します。

 

パラメータ:

dest - - アップロード先。

resource - - アップロード元。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

get

public boolean get(java.lang.String resource,
                   java.lang.String dest)
            throws PFComponentException

サーバから、ファイル・ディレクトリを同名でダウンロードします。

 注意事項
 同名でダウンロードをするため、ダウンロード先の指定には、
 親ディレクトリまでを指定します。
 ダウンロード元であるサーバ上のコンテンツのタイプを自動判定するため、
 ダウンロード前処理として、判定処理のリクエストを送信します。
 対象がディレクトリの場合は、ディレクトリに含まれるコンテンツ数分のリクエストを発行します。

 

パラメータ:

resource - - ダウンロード元。

dest - - ダウンロード先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

getFile

public boolean getFile(java.lang.String resource,
                       java.lang.String dest)
                throws PFComponentException

サーバから、ファイルを同名でダウンロードします。

 注意事項
 同名でダウンロードをするため、ダウンロード先の指定には、
 親ディレクトリまでを指定します。

 

パラメータ:

resource - - ダウンロード元。

dest - - ダウンロード先。(ディレクトリまで)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

getDirectory

public boolean getDirectory(java.lang.String resource,
                            java.lang.String dest)
                     throws PFComponentException

サーバから、ディレクトリを同名でダウンロードする。

 注意事項
 同名でダウンロードをするため、ダウンロード先の指定には、
 親ディレクトリまでを指定します。
 ディレクトリに含まれるコンテンツ数分のリクエストを発行します。

 

パラメータ:

resource - - ダウンロード元。

dest - - ダウンロード先。(ディレクトリまで)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

getReserve

public boolean getReserve(java.lang.String resource,
                          java.lang.String dest)
                   throws PFComponentException

サーバから、ファイル・ディレクトリをダウンロードをダウンロードする。

 注意事項
 ダウンロード先には名称まで指定します。
 ダウンロード元であるサーバ上のコンテンツのタイプを自動判定するため、
 ダウンロード前処理として、判定処理のリクエストを送信します。
 対象がディレクトリの場合は、ディレクトリに含まれるコンテンツ数分のリクエストを発行します。

 

パラメータ:

resource - - ダウンロード元。

dest - - ダウンロード先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

getFileReserve

public boolean getFileReserve(java.lang.String resource,
                              java.lang.String dest)
                       throws PFComponentException

サーバから、ファイルをダウンロードします。

 注意事項
 ダウンロード先には名称まで指定します。

 

パラメータ:

resource - - ダウンロード元。

dest - - ダウンロード先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

getDirectoryReserve

public boolean getDirectoryReserve(java.lang.String resource,
                                   java.lang.String dest)
                            throws PFComponentException

サーバから、ディレクトリをダウンロードする。

 注意事項
 ダウンロード先には名称まで指定します。
 ディレクトリに含まれるコンテンツ数分のリクエストを発行します。

 

パラメータ:

resource - - ダウンロード元。

dest - - ダウンロード先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

delete

public boolean delete(java.lang.String dest)
               throws PFComponentException

指定のファイル・ディレクトリを削除します。

 注意事項
 削除対象であるサーバ上のコンテンツのタイプを自動判定するため、
 削除前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - 削除対象のファイル・ディレクトリ。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

deleteFile

public boolean deleteFile(java.lang.String dest)
                   throws PFComponentException

指定のファイルを削除します。

 注意事項
 なし。

 

パラメータ:

dest - - 削除対象のファイル。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

deleteDirectory

public boolean deleteDirectory(java.lang.String dest)
                        throws PFComponentException

指定のディレクトリを削除します。

 注意事項
 なし。

 

パラメータ:

dest - - 削除対象のディレクトリ。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

mkdir

public boolean mkdir(java.lang.String dest)
              throws PFComponentException

指定のディレクトリをサーバ上に作成する。

 注意事項
 なし。

 

パラメータ:

dest - - 作成先ディレクトリ。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

copy

public boolean copy(java.lang.String resource,
                    java.lang.String dest)
             throws PFComponentException

ファイル・ディレクトリをコピーします。

 注意事項
 同名でコピーするため、コピー先の指定には、
 親ディレクトリまでを指定します。
 コピー対象であるサーバ上のコンテンツのタイプを自動判定するため、
 コピー前処理として、判定処理のリクエストを送信します。

 

パラメータ:

resource - - コピー元。

dest - - コピー先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

copyFile

public boolean copyFile(java.lang.String resource,
                        java.lang.String dest)
                 throws PFComponentException

ファイルを同名でコピーします。

 注意事項
 同名でコピーをするため、コピー先の指定には、
 親ディレクトリまでを指定します。

 

パラメータ:

resource - - コピー元。

dest - - コピー先。(ディレクトリまで)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

copyDirectory

public boolean copyDirectory(java.lang.String resource,
                             java.lang.String dest)
                      throws PFComponentException

ディレクトリを同名でコピーします。

 注意事項
 同名でコピーをするため、コピー先の指定には、
 親ディレクトリまでを指定します。

 

パラメータ:

resource - - コピー元。

dest - - コピー先。(ディレクトリまで)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

copyReserve

public boolean copyReserve(java.lang.String resource,
                           java.lang.String dest)
                    throws PFComponentException

ファイル・ディレクトリをコピーする。

 注意事項
 コピー先には名称まで指定します。
 コピー対象であるサーバ上のコンテンツのタイプを自動判定するため、
 コピー前処理として、判定処理のリクエストを送信します。

 

パラメータ:

resource - - コピー元。

dest - - コピー先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

copyFileReserve

public boolean copyFileReserve(java.lang.String resource,
                               java.lang.String dest)
                        throws PFComponentException

ファイルをコピーします。

 注意事項
 コピー先には名称まで指定します。

 

パラメータ:

resource - - コピー元。

dest - - コピー先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

copyDirectoryReserve

public boolean copyDirectoryReserve(java.lang.String resource,
                                    java.lang.String dest)
                             throws PFComponentException

ディレクトリをコピーします。

 コピー先には名称まで指定します。

 注意事項

 

パラメータ:

resource - - コピー元。

dest - - コピー先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

move

public boolean move(java.lang.String resource,
                    java.lang.String dest)
             throws PFComponentException

ファイル・ディレクトリを移動します。

 注意事項
 同名で移動するため、移動先の指定には、
 親ディレクトリまでを指定します。
 移動対象であるサーバ上のコンテンツのタイプを自動判定するため、
 移動前処理として、判定処理のリクエストを送信します。

 

パラメータ:

resource - - 移動元。

dest - - 移動先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

moveFile

public boolean moveFile(java.lang.String resource,
                        java.lang.String dest)
                 throws PFComponentException

ファイルを同名で移動します。

 注意事項
 同名で移動をするため、移動先の指定には、
 親ディレクトリまでを指定します。

 

パラメータ:

resource - - 移動元。

dest - - 移動先。(ディレクトリまで)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

moveDirectory

public boolean moveDirectory(java.lang.String resource,
                             java.lang.String dest)
                      throws PFComponentException

ディレクトリを同名で移動します。

 注意事項
 同名で移動をするため、移動先の指定には、
 親ディレクトリまでを指定します。

 

パラメータ:

resource - - 移動元。

dest - - 移動先。(ディレクトリまで)

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

moveReserve

public boolean moveReserve(java.lang.String resource,
                           java.lang.String dest)
                    throws PFComponentException

ファイル・ディレクトリを移動する。

 注意事項
 移動先には名称まで指定します。
 移動対象であるサーバ上のコンテンツのタイプを自動判定するため、
 移動前処理として、判定処理のリクエストを送信します。

 

パラメータ:

resource - - 移動元。

dest - - 移動先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

moveFileReserve

public boolean moveFileReserve(java.lang.String resource,
                               java.lang.String dest)
                        throws PFComponentException

ファイルを移動します。

 注意事項
 移動先には名称まで指定します。

 

パラメータ:

resource - - 移動元。

dest - - 移動先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

moveDirectoryReserve

public boolean moveDirectoryReserve(java.lang.String resource,
                                    java.lang.String dest)
                             throws PFComponentException

ディレクトリを移動します。

 移動先には名称まで指定します。

 注意事項

 

パラメータ:

resource - - 移動元。

dest - - 移動先。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

rename

public boolean rename(java.lang.String resource,
                      java.lang.String name)
               throws PFComponentException

指定のファイル・ディレクトリをリネームします。

 注意事項
 第2引数には名称のみを設定します。
 コピー対象であるサーバ上のコンテンツのタイプを自動判定するため、
 コピー前処理として、判定処理のリクエストを送信します。

 

パラメータ:

resource - - リネーム対象のファイル・ディレクトリ。

name - - 名称。

戻り値:

処理結果ステータス。
true: success, false: fail

例外:

PFComponentException - 例外発生。

setPath

public void setPath(java.lang.String dest)
             throws PFComponentException

パスをURLに設定します。

 注意事項
 なし。

 

例外:

PFComponentException - 例外発生。

getPath

public java.lang.String getPath()
                         throws PFComponentException

パスを取得します。

 注意事項
 なし。

 

戻り値:

path

例外:

PFComponentException - 例外発生。

list

public PFObjectList list(java.lang.String dest)
                  throws PFComponentException

指定直下のファイル・ディレクトリ名称を取得します。

 注意事項
 ファイルを指定した場合は例外が発生します。

 

パラメータ:

dest - - サーバ上のディレクトリ。

戻り値:

ファイル・ディレクトリ名称のリスト。(要素はString)

例外:

PFComponentException - 例外発生。

getLength

public long getLength(java.lang.String dest)
               throws PFComponentException

指定のファイル・ディレクトリサイズを取得します。

 注意事項
 現状、ディレクトリの場合はサイズが 0。
 サイズ取得対象であるサーバ上のコンテンツのタイプを自動判定するため、
 サイズ取得前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - ファイル・ディレクトリ。

戻り値:

ファイル・ディレクトリサイズ。

例外:

PFComponentException - 例外発生。

getFileLength

public long getFileLength(java.lang.String dest)
                   throws PFComponentException

指定のファイルサイズを取得します。

 注意事項
 なし。

 

パラメータ:

dest - - ファイル。

戻り値:

ファイルサイズ。

例外:

PFComponentException - 例外発生。

getDirectoryLength

public long getDirectoryLength(java.lang.String dest)
                        throws PFComponentException

指定のディレクトリサイズを取得します。

 注意事項
 なし。

 

パラメータ:

dest - - ディレクトリ。

戻り値:

ディレクトリサイズ。

例外:

PFComponentException - 例外発生。

getLastModified

public java.lang.String getLastModified(java.lang.String dest)
                                 throws PFComponentException

指定のファイル・ディレクトリの最終更新日付を取得します。

 注意事項
 最終更新日付取得対象であるサーバ上のコンテンツのタイプを自動判定するため、
 最終更新日付取得前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - ファイル・ディレクトリ。

戻り値:

ファイル・ディレクトリの最終更新日付。

例外:

PFComponentException - 例外発生。

getFileLastModified

public java.lang.String getFileLastModified(java.lang.String dest)
                                     throws PFComponentException

指定のファイルの最終更新日付を取得します。

 注意事項
 最終更新日付取得対象であるサーバ上のコンテンツのタイプを自動判定するため、
 最終更新日付取得前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - ファイル。

戻り値:

ファイルの最終更新日付。

例外:

PFComponentException - 例外発生。

getDirectoryLastModified

public java.lang.String getDirectoryLastModified(java.lang.String dest)
                                          throws PFComponentException

指定のディレクトリの最終更新日付を取得します。

 注意事項
 最終更新日付取得対象であるサーバ上のコンテンツのタイプを自動判定するため、
 最終更新日付取得前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - ディレクトリ。

戻り値:

ディレクトリの最終更新日付。

例外:

PFComponentException - 例外発生。

isFile

public boolean isFile(java.lang.String resource)
               throws PFComponentException

ファイルかどうかチェックします。

 注意事項
 なし。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: file, false: not file

例外:

PFComponentException - 例外発生。

isDirectory

public boolean isDirectory(java.lang.String resource)
                    throws PFComponentException

ディレクトリかどうかチェックします。

 注意事項
 なし。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: directory, false: not directory

例外:

PFComponentException - 例外発生。

isHidden

public boolean isHidden(java.lang.String resource)
                 throws PFComponentException

隠しファイル・ディレクトリかどうかチェックします。

 注意事項
 なし。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: hidden, false: not hidden

例外:

PFComponentException - 例外発生。

isLocked

public boolean isLocked(java.lang.String resource)
                 throws PFComponentException

ロックがかかっているファイル・ディレクトリかどうかチェックします。

 注意事項
 ロック対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック前処理として、判定処理のリクエストを送信します。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: lcok, false: unlock

例外:

PFComponentException - 例外発生。

isExists

public boolean isExists(java.lang.String resource)
                 throws PFComponentException

存在しているファイル・ディレクトリかどうかチェックします。

 注意事項
 なし。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: exist, false: not exist

例外:

PFComponentException - 例外発生。

isExistsFile

public boolean isExistsFile(java.lang.String resource)
                     throws PFComponentException

存在しているファイルかどうかチェックします。

 注意事項
 なし。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: exist, false: not exist

例外:

PFComponentException - 例外発生。

isExistsDirectory

public boolean isExistsDirectory(java.lang.String resource)
                          throws PFComponentException

存在しているディレクトリかどうかチェックします。

 注意事項
 なし。

 

パラメータ:

resource - - 名称。

戻り値:

処理結果ステータス。
true: exist, false: not exist

例外:

PFComponentException - 例外発生。

getRoots

public java.lang.String getRoots()
                          throws PFComponentException

ルートパスを取得。

 注意事項
 なし。

 

戻り値:

ファイル・ディレクトリ名称のリスト。(要素はString)

例外:

PFComponentException - 例外発生。

listSubDirectoryNames

public PFObjectList listSubDirectoryNames(java.lang.String dest)
                                   throws PFComponentException

指定したディレクトリ直下に存在するディレクトリ名称の配列を取得します。

 注意事項
 引数にファイルを指定した場合は例外が発生します。

 

パラメータ:

dest - - 対象ディレクトリ

戻り値:

ディレクトリ名称の配列 (要素は String )

例外:

PFComponentException - 例外発生。

listSubFileNames

public PFObjectList listSubFileNames(java.lang.String dest)
                              throws PFComponentException

指定したディレクトリ直下に存在するファイル名称の配列を取得します。

 注意事項
 引数にファイルを指定した場合は例外が発生します。

 

パラメータ:

dest - - 対象ディレクトリ

戻り値:

ファイル名称の配列 (要素は String )

例外:

PFComponentException - 例外発生。

setOverwrite

public void setOverwrite(boolean overwrite)
                  throws PFComponentException

読み取り属性を設定する。

 注意事項
 なし。

 

パラメータ:

overwrite - true: overwrite, false: not overwrite

例外:

PFComponentException - 例外発生。

isOverwrite

public boolean isOverwrite()
                    throws PFComponentException

読み取り属性を判定する。

 注意事項
 なし。

 

例外:

PFComponentException - 例外発生。

lock

public boolean lock(java.lang.String dest,
                    java.lang.String owner)
             throws PFComponentException

ファイル・ディレクトリを排他ロックする。

 注意事項
 ロックタイムアウト時間はデフォルトを使用します。
 ロック対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル・ディレクトリ。

owner - - 所有者

戻り値:

処理結果ステータス。
true: lock, false: not lock

例外:

PFComponentException - 例外発生。

lock

public boolean lock(java.lang.String dest,
                    java.lang.String owner,
                    int timeout)
             throws PFComponentException

ファイル・ディレクトリを排他ロックする。

 注意事項
 ロック対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル・ディレクトリ。

owner - - 所有者

timeout - - ロックタイムアウト時間

戻り値:

処理結果ステータス。
true: lock, false: not lock

例外:

PFComponentException - 例外発生。

lockFile

public boolean lockFile(java.lang.String dest,
                        java.lang.String owner)
                 throws PFComponentException

ファイルを排他ロックする。

 注意事項
 ロックタイムアウト時間はデフォルトを使用します。

 

パラメータ:

dest - - サーバ上のファイル。

owner - - 所有者

戻り値:

処理結果ステータス。
true: lock, false: not lock

例外:

PFComponentException - 例外発生。

lockFile

public boolean lockFile(java.lang.String dest,
                        java.lang.String owner,
                        int timeout)
                 throws PFComponentException

ファイルを排他ロックする。

 注意事項
 ロックタイムアウト時間はデフォルトを使用します。

 

パラメータ:

dest - - サーバ上のファイル。

owner - - 所有者

timeout - - ロックタイムアウト時間

戻り値:

処理結果ステータス。
true: lock, false: not lock

例外:

PFComponentException - 例外発生。

setLockDefaultTimeout

public void setLockDefaultTimeout(int timeout)

タイムアウトまでの時間を設定する。

 注意事項
 なし。

 

パラメータ:

timeout - - タイムアウトまでの時間。

例外:

PFComponentException - 例外発生。

unlockFile

public boolean unlockFile(java.lang.String dest,
                          java.lang.String owner)
                   throws PFComponentException

ファイルを排他ロックする。

 注意事項
 ロックをかけた本人のみがこの処理を実行できます。

 

パラメータ:

dest - - サーバ上のファイル。

owner - - 所有者

戻り値:

処理結果ステータス。
true: unlock, false: not unlock

例外:

PFComponentException - 例外発生。

unlock

public boolean unlock(java.lang.String dest,
                      java.lang.String owner)
               throws PFComponentException

ファイル・ディレクトリを排他ロックする。

 注意事項
 ロックをかけた本人のみがこの処理を実行できます。
 ロック対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル・ディレクトリ。

owner - - 所有者

戻り値:

処理結果ステータス。
true: unlock, false: not unlock

例外:

PFComponentException - 例外発生。

releaseLockFile

public boolean releaseLockFile(java.lang.String dest)
                        throws PFComponentException

ファイルにかかっている排他ロックを解除します。

 注意事項
 ロック解除対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック解除前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル。

戻り値:

処理結果ステータス。
true: release lock, false: not release lock

例外:

PFComponentException - 例外発生。

releaseLock

public boolean releaseLock(java.lang.String dest)
                    throws PFComponentException

ファイル・ディレクトリにかかっている排他ロックを解除します。

 注意事項
 ロック解除対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック解除前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル・ディレクトリ。

戻り値:

処理結果ステータス。
true: release lock, false: not release lock

例外:

PFComponentException - 例外発生。

stealLock

public boolean stealLock(java.lang.String dest)
                  throws PFComponentException

ファイル・ディレクトリにかかっている排他ロックを自分のものにします。

 注意事項
 ロック解除対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック解除前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル・ディレクトリ。

戻り値:

処理結果ステータス。
true: steal lock, false: not steal lock

例外:

PFComponentException - 例外発生。

getLockInfo

public PFObjectList getLockInfo(java.lang.String dest)
                         throws PFComponentException

ファイル・ディレクトリにかかっている排他ロック情報を取得します。

 注意事項
 ロック情報取得対象であるサーバ上のコンテンツのタイプを自動判定するため、
 ロック情報取得前処理として、判定処理のリクエストを送信します。

 

パラメータ:

dest - - サーバ上のファイル・ディレクトリ。

戻り値:

処理結果ステータス。
true: succes, false:fail

例外:

PFComponentException - 例外発生。

getAllDirectoriesTree

public PFObjectTree getAllDirectoriesTree(java.lang.String dest)
                                   throws PFComponentException

パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、例外を発生します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

パラメータ:

dest - サーバ上のディレクトリ。

戻り値:

パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト

例外:

PFComponentException - 例外発生。

getAllDirectoriesTreeMulti

public PFObjectTree getAllDirectoriesTreeMulti(java.lang.String dest)
                                        throws PFComponentException

パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。

 注意事項
 ルートノードは自動で設定します。
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用します。
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、例外を発生します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:

パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト

例外:

PFComponentException - ディレクトリが設定されていない場合

addSubDirectoriesTree

public void addSubDirectoriesTree(PFObjectTreeNode parent)
                           throws PFComponentException

指定のノードの直下に存在するディレクトリのノードを追加します。

 注意事項
 なし。

 

パラメータ:

parent - 対象ノード

例外:

PFComponentException

addSubDirectoriesTree

public void addSubDirectoriesTree(PFObjectTreeNode parent,
                                  java.lang.String temp)
                           throws PFComponentException

指定のノードの直下に存在するディレクトリのノードを追加します。 各ノードの直下に指定した名称でノードを作成します。

 注意事項
 なし。

 

パラメータ:

parent - 対象ノード

temp - 各ノードの直下につけるノード名称

例外:

PFComponentException

addSubDirectoriesTree

public void addSubDirectoriesTree(PFObjectTreeNode parent,
                                  java.lang.String dest,
                                  java.lang.String temp)
                           throws PFComponentException

指定のノードの直下に存在するディレクトリのノードを追加します。 各ノードの直下に指定した名称でノードを作成します。

 注意事項
 なし。

 

パラメータ:

parent - 対象ノード

dest - 追加対象ノード

temp - 各ノードの直下につけるノード名称

例外:

PFComponentException

getSubDirectoriesNode

public PFObjectTreeNode getSubDirectoriesNode(java.lang.String dest,
                                              java.lang.String temp)
                                       throws PFComponentException

指定のパスでノードを作成し、その直下に存在するディレクトリを追加したものを取得します。 各ノードの直下に指定した名称でノードを作成します。

 注意事項
 なし。

 

パラメータ:

dest - 対象ノード

temp - 各ノードの直下につけるノード名称

例外:

PFComponentException

getSubDirectoriesNodeList

public PFObjectList getSubDirectoriesNodeList(java.lang.String dest,
                                              java.lang.String temp)
                                       throws PFComponentException

指定のパスの直下に存在するノードのリストを取得します。 各ノードの直下に指定した名称でノードを作成します。

 注意事項
 なし。

 

パラメータ:

dest - 指定パス

temp - 各ノードの直下につけるノード名称

例外:

PFComponentException