ContentsStoreService (WebUDA Tuigwaa 1.0 API)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.seasar.tuigwaa.cms
インタフェース ContentsStoreService

既知の実装クラスの一覧:: ContentsStoreServiceSlideImpl

public interface ContentsStoreService

作成者:: nishioka

フィールドの概要
`static String`	`DEFAULT_ENCODING`
`static int`	`RETRIEVETYPE_FOLDER`
`static int`	`RETRIEVETYPE_PAGE`
`static int`	`RETRIEVETYPE_PAGEFOLDER`

メソッドの概要
`boolean`	`checkVersion(Resource resource, String version)` 推奨されていません。
`void`	`copy(String srcSiteName, String srcPath, String destSiteName, String destPath)`
`void`	`copyFromFileSystem(File srcDirectory, String targetSiteName)`
`void`	`copyToFileSystem(String targetSiteName, String srcPath, File srcDirectory)`
`void`	`createAttachment(String siteName, String pagePath, String fileName, String contentType, int contentLength, InputStream data)`
`void`	`createFolder(String siteName, String folderPath)`
`void`	`createPage(Page page)`
`void`	`createResource(String siteName, String path, String contentType, int contentLength, InputStream data)`
`void`	`createThumbnail(Resource resource, OutputStream os, int width, String formatName)`
`void`	`delete(String siteName, String path)`
`List`	`getAttachmentFileList(String siteName, String pagePath)`
`Resource`	`getAttachmentResource(String siteName, String pagePath, String fileName)`
`String`	`getContent(Resource resource)` 推奨されていません。
`com.isenshi.util.Diff`	`getDiff(String siteName, String pagePath, String oldVersion)`
`List`	`getFolderList(String siteName, String folderPath)`
`List`	`getHistory(String siteName, String pagePath)`
`List`	`getLatestContents(String siteName, int size)`
`Page`	`getPage(String siteName, String pagePath)`
`List`	`getPageList(String siteName, String folderPath)`
`List`	`getPageOrFolderList(String siteName, String folderPath)`
`Properties`	`getProperty(String siteName, String path)`
`List`	`getRecursiveFolderList(String siteName, String folderPath)`
`List`	`getRecursivePageList(String siteName, String folderPath)`
`List`	`getRecursivePageOrFolderList(String siteName, String folderPath)`
`Resource`	`getResource(String siteName, String pagePath)`
`boolean`	`hasPermission(String siteName, String path, String role)`
`boolean`	`isExist(String siteName, String pagePath)` 推奨されていません。
`boolean`	`isExistPage(String siteName, String pagePath)` 推奨されていません。
`boolean`	`isExistResource(String siteName, String pagePath, boolean pageOnly)` リソースの存在をチェックする
`void`	`move(String siteName, String pagePath, String newParentPath)`
`void`	`refreshCache(String siteName)`
`void`	`refreshCache(String path, boolean isSite)`
`void`	`removeProperty(String siteName, String path, String key)`
`void`	`rename(String siteName, String pagePath, String newPageName)`
`List`	`search(String siteName, String keyword)`
`void`	`setPermissions(String siteName, String path, String[] grantRoles, String[] denyRoles)`
`void`	`setProperty(String siteName, String path, Properties props)`
`void`	`writeAttachment(String siteName, String pagePath, String fileName, OutputStream os)`
`void`	`writeResource(String siteName, String path, OutputStream os)`

フィールドの詳細

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

関連項目:: 定数フィールド値

RETRIEVETYPE_PAGE

public static final int RETRIEVETYPE_PAGE

関連項目:: 定数フィールド値

RETRIEVETYPE_FOLDER

public static final int RETRIEVETYPE_FOLDER

関連項目:: 定数フィールド値

RETRIEVETYPE_PAGEFOLDER

public static final int RETRIEVETYPE_PAGEFOLDER

関連項目:: 定数フィールド値

メソッドの詳細

getPage

public Page getPage(String siteName,
                    String pagePath)
             throws TgwSecurityException

例外:: TgwSecurityException

createPage

public void createPage(Page page)
                throws TgwResourceCreationException

例外:: TgwResourceCreationException

createFolder

public void createFolder(String siteName,
                         String folderPath)
                  throws TgwSecurityException,
                         TgwResourceAlreadyExistsException

例外:: TgwSecurityException; TgwResourceAlreadyExistsException

createResource

public void createResource(String siteName,
                           String path,
                           String contentType,
                           int contentLength,
                           InputStream data)
                    throws TgwResourceCreationException

例外:: TgwResourceCreationException

delete

public void delete(String siteName,
                   String path)

rename

public void rename(String siteName,
                   String pagePath,
                   String newPageName)
            throws TgwResourceAlreadyExistsException

例外:: TgwResourceAlreadyExistsException

move

public void move(String siteName,
                 String pagePath,
                 String newParentPath)
          throws TgwResourceAlreadyExistsException

例外:: TgwResourceAlreadyExistsException

copy

public void copy(String srcSiteName,
                 String srcPath,
                 String destSiteName,
                 String destPath)
          throws TgwException

例外:: TgwException

setProperty

public void setProperty(String siteName,
                        String path,
                        Properties props)
                 throws TgwResourceNotFoundException,
                        TgwSecurityException,
                        TgwException

例外:: TgwResourceNotFoundException; TgwSecurityException; TgwException

getProperty

public Properties getProperty(String siteName,
                              String path)
                       throws TgwResourceNotFoundException,
                              TgwSecurityException,
                              TgwException

例外:: TgwResourceNotFoundException; TgwSecurityException; TgwException

removeProperty

public void removeProperty(String siteName,
                           String path,
                           String key)
                    throws TgwResourceNotFoundException,
                           TgwSecurityException,
                           TgwException

例外:: TgwResourceNotFoundException; TgwSecurityException; TgwException

getResource

public Resource getResource(String siteName,
                            String pagePath)
                     throws TgwSecurityException

例外:: TgwSecurityException

writeResource

public void writeResource(String siteName,
                          String path,
                          OutputStream os)
                   throws IOException

例外:: IOException

search

public List search(String siteName,
                   String keyword)
            throws TgwSearchFailedException

例外:: TgwSearchFailedException

getLatestContents

public List getLatestContents(String siteName,
                              int size)
                       throws TgwSearchFailedException

例外:: TgwSearchFailedException

isExistResource

public boolean isExistResource(String siteName,
                               String pagePath,
                               boolean pageOnly)
                        throws TgwSecurityException

リソースの存在をチェックする

パラメータ:: siteName - サイト名; pagePath - リソースへのパス; pageOnly - 該当リソースがページであるかのチェックを行うか否かをあらわすフラグ
戻り値:: リソースが存在していたら真、存在しない場合は偽、また pageOnly が真の場合はリソースが存在し、かつ、それがフォルダでない場合にのみ真を返す
例外:: TgwSecurityException - 該当のリソースをチェックする権限がない場合にスローされる

isExist

public boolean isExist(String siteName,
                       String pagePath)
                throws TgwSecurityException

推奨されていません。

例外:: TgwSecurityException

isExistPage

public boolean isExistPage(String siteName,
                           String pagePath)
                    throws TgwSecurityException

推奨されていません。

例外:: TgwSecurityException

getContent

public String getContent(Resource resource)
                  throws TgwSecurityException

推奨されていません。

例外:: TgwSecurityException

getDiff

public com.isenshi.util.Diff getDiff(String siteName,
                                     String pagePath,
                                     String oldVersion)

getHistory

public List getHistory(String siteName,
                       String pagePath)

checkVersion

public boolean checkVersion(Resource resource,
                            String version)

推奨されていません。

copyFromFileSystem

public void copyFromFileSystem(File srcDirectory,
                               String targetSiteName)
                        throws TgwResourceCreationException,
                               TgwSecurityException

例外:: TgwResourceCreationException; TgwSecurityException

copyToFileSystem

public void copyToFileSystem(String targetSiteName,
                             String srcPath,
                             File srcDirectory)
                      throws TgwSecurityException,
                             IOException

例外:: TgwSecurityException; IOException

createAttachment

public void createAttachment(String siteName,
                             String pagePath,
                             String fileName,
                             String contentType,
                             int contentLength,
                             InputStream data)
                      throws TgwSecurityException,
                             TgwResourceCreationException

例外:: TgwSecurityException; TgwResourceCreationException

writeAttachment

public void writeAttachment(String siteName,
                            String pagePath,
                            String fileName,
                            OutputStream os)
                     throws IOException

例外:: IOException

getAttachmentFileList

public List getAttachmentFileList(String siteName,
                                  String pagePath)
                           throws TgwSecurityException

例外:: TgwSecurityException

getAttachmentResource

public Resource getAttachmentResource(String siteName,
                                      String pagePath,
                                      String fileName)
                               throws TgwSecurityException,
                                      TgwResourceNotFoundException

例外:: TgwSecurityException; TgwResourceNotFoundException

createThumbnail

public void createThumbnail(Resource resource,
                            OutputStream os,
                            int width,
                            String formatName)

getPageOrFolderList

public List getPageOrFolderList(String siteName,
                                String folderPath)
                         throws TgwSecurityException

例外:: TgwSecurityException

getRecursivePageOrFolderList

public List getRecursivePageOrFolderList(String siteName,
                                         String folderPath)
                                  throws TgwSecurityException

例外:: TgwSecurityException

getPageList

public List getPageList(String siteName,
                        String folderPath)
                 throws TgwSecurityException

例外:: TgwSecurityException

getRecursivePageList

public List getRecursivePageList(String siteName,
                                 String folderPath)
                          throws TgwSecurityException

例外:: TgwSecurityException

getRecursiveFolderList

public List getRecursiveFolderList(String siteName,
                                   String folderPath)
                            throws TgwSecurityException

例外:: TgwSecurityException

getFolderList

public List getFolderList(String siteName,
                          String folderPath)
                   throws TgwSecurityException

例外:: TgwSecurityException

hasPermission

public boolean hasPermission(String siteName,
                             String path,
                             String role)

setPermissions

public void setPermissions(String siteName,
                           String path,
                           String[] grantRoles,
                           String[] denyRoles)

refreshCache

public void refreshCache(String siteName)

refreshCache

public void refreshCache(String path,
                         boolean isSite)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.seasar.tuigwaa.cms インタフェース ContentsStoreService

DEFAULT_ENCODING

RETRIEVETYPE_PAGE

RETRIEVETYPE_FOLDER

RETRIEVETYPE_PAGEFOLDER

getPage

createPage

createFolder

createResource

delete

rename

move

copy

setProperty

getProperty

removeProperty

getResource

writeResource

search

getLatestContents

isExistResource

isExist

isExistPage

getContent

getDiff

getHistory

checkVersion

copyFromFileSystem

copyToFileSystem

createAttachment

writeAttachment

getAttachmentFileList

getAttachmentResource

createThumbnail

getPageOrFolderList

getRecursivePageOrFolderList

getPageList

getRecursivePageList

getRecursiveFolderList

getFolderList

hasPermission

setPermissions

refreshCache

refreshCache

org.seasar.tuigwaa.cms
インタフェース ContentsStoreService