StringResourceLoader (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- org.apache.velocity.runtime.resource.loader.ResourceLoader
- - edu.internet2.middleware.shibboleth.common.util.StringResourceLoader

```
public class StringResourceLoader
extends org.apache.velocity.runtime.resource.loader.ResourceLoader
```
Resource loader that works with Strings. Users should manually add resources to the repository that is used by the resource loader instance. Below is an example configuration for this loader. Note that 'repository.class' is not necessary; if not provided, the factory will fall back on using StringResourceRepositoryImpl as the default.
```
 resource.loader = string
 string.resource.loader.description = Velocity StringResource loader
 string.resource.loader.class = org.apache.velocity.runtime.resource.loader.StringResourceLoader
 string.resource.loader.repository.class = org.apache.velocity.runtime.resource.loader.StringResourceRepositoryImpl
 
```
Resources can be added to the repository like this:
```
 StringResourceRepository repo = StringResourceLoader.getRepository();
 String myTemplateName = "/some/imaginary/path/hello.vm";
 String myTemplate = "Hi, ${username}... this is some template!";
 repo.putStringResource(myTemplateName, myTemplate);
 
```
After this, the templates can be retrieved as usual.

If there will be multiple StringResourceLoaders used in an application, you should consider specifying a 'string.resource.loader.repository.name = foo' property in order to keep you string resources in a non-default repository. This can help to avoid conflicts between different frameworks or components that are using StringResourceLoader. You can then retrieve your named repository like this:
```
 StringResourceRepository repo = StringResourceLoader.getRepository("foo");
 
```
and add string resources to the repo just as in the previous example.

If you have concerns about memory leaks or for whatever reason do not wish to have your string repository stored statically as a class member, then you should set 'string.resource.loader.repository.static = false' in your properties. This will tell the resource loader that the string repository should be stored in the Velocity application attributes. To retrieve the repository, do:
```
 StringResourceRepository repo = velocityEngine.getApplicationAttribute("foo");
 
```
If you did not specify a name for the repository, then it will be stored under the class name of the repository implementation class (for which the default is 'org.apache.velocity.runtime.resource.util.StringResourceRepositoryImpl'). Incidentally, this is also true for the default statically stored repository.

Whether your repository is stored statically or in Velocity's application attributes, you can also manually create and set it prior to Velocity initialization. For a static repository, you can do something like this:
```
 StringResourceRepository repo = new MyStringResourceRepository();
 repo.magicallyAddSomeStringResources();
 StringResourceLoader.setRepository("foo", repo);
 
```
Or for a non-static repository:
```
 StringResourceRepository repo = new MyStringResourceRepository();
 repo.magicallyAddSomeStringResources();
 velocityEngine.setApplicationAttribute("foo", repo);
 
```
Then, assuming the 'string.resource.loader.repository.name' property is set to 'some.name', the StringResourceLoader will use that already created repository, rather than creating a new one.
バージョン:

535935

作成者:

Eelco Hillenius, Henning P. Schmiedehausen, Nathan Bubna

フィールドの概要

フィールド
修飾子とタイプ	フィールドと説明
`protected org.apache.velocity.runtime.resource.util.StringResourceRepository`	`repository`
`static String`	`REPOSITORY_CLASS` Key to look up the repository implementation class.
`static String`	`REPOSITORY_CLASS_DEFAULT` The default implementation class.
`static String`	`REPOSITORY_ENCODING` Key to look up the repository char encoding.
`static String`	`REPOSITORY_ENCODING_DEFAULT` The default repository encoding.
`static String`	`REPOSITORY_NAME` Key to look up the name for the repository to be used.
`static String`	`REPOSITORY_NAME_DEFAULT` The default name for string resource repositories ('org.apache.velocity.runtime.resource.util.StringResourceRepository').
`static String`	`REPOSITORY_STATIC` Key to determine whether the repository should be set as the static one or not.
`static boolean`	`REPOSITORY_STATIC_DEFAULT` By default, repositories are stored statically (shared across the VM).
`protected static Map`	`STATIC_REPOSITORIES`

クラスから継承されたフィールド org.apache.velocity.runtime.resource.loader.ResourceLoader
className, isCachingOn, log, modificationCheckInterval, rsvc

コンストラクタの概要

コンストラクタ
コンストラクタと説明

StringResourceLoader()

コンストラクタ
コンストラクタと説明
`StringResourceLoader()`

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`static void`	`clearRepositories()` Removes all statically stored `StringResourceRepository`s.
`org.apache.velocity.runtime.resource.util.StringResourceRepository`	`createRepository(String className, String encoding)`
`long`	`getLastModified(org.apache.velocity.runtime.resource.Resource resource)`
`static org.apache.velocity.runtime.resource.util.StringResourceRepository`	`getRepository()` Returns a reference to the default static repository.
`static org.apache.velocity.runtime.resource.util.StringResourceRepository`	`getRepository(String name)` Returns a reference to the repository stored statically under the specified name.
`InputStream`	`getResourceStream(String name)` Get an InputStream so that the Runtime can build a template with it.
`void`	`init(org.apache.commons.collections.ExtendedProperties configuration)`
`boolean`	`isSourceModified(org.apache.velocity.runtime.resource.Resource resource)`
`static org.apache.velocity.runtime.resource.util.StringResourceRepository`	`removeRepository(String name)` Removes the `StringResourceRepository` stored under the specified name.
`static void`	`setRepository(String name, org.apache.velocity.runtime.resource.util.StringResourceRepository repo)` Sets the specified `StringResourceRepository` in static storage under the specified name.

クラスから継承されたメソッド org.apache.velocity.runtime.resource.loader.ResourceLoader
commonInit, getClassName, getModificationCheckInterval, isCachingOn, setCachingOn, setModificationCheckInterval

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - REPOSITORY_STATIC
```
public static final String REPOSITORY_STATIC
```
    Key to determine whether the repository should be set as the static one or not.
    
    関連項目:
    定数フィールド値
  - REPOSITORY_STATIC_DEFAULT
```
public static final boolean REPOSITORY_STATIC_DEFAULT
```
    By default, repositories are stored statically (shared across the VM).
    
    関連項目:
    定数フィールド値
  - REPOSITORY_CLASS
```
public static final String REPOSITORY_CLASS
```
    Key to look up the repository implementation class.
    
    関連項目:
    定数フィールド値
  - REPOSITORY_CLASS_DEFAULT
```
public static final String REPOSITORY_CLASS_DEFAULT
```
    The default implementation class.
  - REPOSITORY_NAME
```
public static final String REPOSITORY_NAME
```
    Key to look up the name for the repository to be used.
    
    関連項目:
    定数フィールド値
  - REPOSITORY_NAME_DEFAULT
```
public static final String REPOSITORY_NAME_DEFAULT
```
    The default name for string resource repositories ('org.apache.velocity.runtime.resource.util.StringResourceRepository').
  - REPOSITORY_ENCODING
```
public static final String REPOSITORY_ENCODING
```
    Key to look up the repository char encoding.
    
    関連項目:
    定数フィールド値
  - REPOSITORY_ENCODING_DEFAULT
```
public static final String REPOSITORY_ENCODING_DEFAULT
```
    The default repository encoding.
    
    関連項目:
    定数フィールド値
  - STATIC_REPOSITORIES
```
protected static final Map STATIC_REPOSITORIES
```
  - repository
```
protected org.apache.velocity.runtime.resource.util.StringResourceRepository repository
```
- コンストラクタの詳細
  - StringResourceLoader
```
public StringResourceLoader()
```
- メソッドの詳細
  - getRepository
```
public static org.apache.velocity.runtime.resource.util.StringResourceRepository getRepository()
```
    Returns a reference to the default static repository.
  - getRepository
```
public static org.apache.velocity.runtime.resource.util.StringResourceRepository getRepository(String name)
```
    Returns a reference to the repository stored statically under the specified name.
  - setRepository
```
public static void setRepository(String name,
                 org.apache.velocity.runtime.resource.util.StringResourceRepository repo)
```
    Sets the specified StringResourceRepository in static storage under the specified name.
  - removeRepository
```
public static org.apache.velocity.runtime.resource.util.StringResourceRepository removeRepository(String name)
```
    Removes the StringResourceRepository stored under the specified name.
  - clearRepositories
```
public static void clearRepositories()
```
    Removes all statically stored StringResourceRepositorys.
  - init
```
public void init(org.apache.commons.collections.ExtendedProperties configuration)
```
    定義:
    
    init クラス内 org.apache.velocity.runtime.resource.loader.ResourceLoader
    
    関連項目:
    ResourceLoader.init(org.apache.commons.collections.ExtendedProperties)
  - createRepository
```
public org.apache.velocity.runtime.resource.util.StringResourceRepository createRepository(String className,
                                                                                  String encoding)
```
  - getResourceStream
```
public InputStream getResourceStream(String name)
                              throws org.apache.velocity.exception.ResourceNotFoundException
```
    Get an InputStream so that the Runtime can build a template with it.
    
    定義:
    
    getResourceStream クラス内 org.apache.velocity.runtime.resource.loader.ResourceLoader
    
    パラメータ:
    name - name of template to get.
    
    戻り値:
    InputStream containing the template.
    
    例外:
    
    org.apache.velocity.exception.ResourceNotFoundException - Ff template not found in the RepositoryFactory.
  - isSourceModified
```
public boolean isSourceModified(org.apache.velocity.runtime.resource.Resource resource)
```
    定義:
    
    isSourceModified クラス内 org.apache.velocity.runtime.resource.loader.ResourceLoader
    
    関連項目:
    ResourceLoader.isSourceModified(org.apache.velocity.runtime.resource.Resource)
  - getLastModified
```
public long getLastModified(org.apache.velocity.runtime.resource.Resource resource)
```
    定義:
    
    getLastModified クラス内 org.apache.velocity.runtime.resource.loader.ResourceLoader
    
    関連項目:
    ResourceLoader.getLastModified(org.apache.velocity.runtime.resource.Resource)

クラス StringResourceLoader

フィールドの概要

クラスから継承されたフィールド org.apache.velocity.runtime.resource.loader.ResourceLoader

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド org.apache.velocity.runtime.resource.loader.ResourceLoader

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

フィールドの詳細

REPOSITORY_STATIC

REPOSITORY_STATIC_DEFAULT

REPOSITORY_CLASS

REPOSITORY_CLASS_DEFAULT

REPOSITORY_NAME

REPOSITORY_NAME_DEFAULT

REPOSITORY_ENCODING

REPOSITORY_ENCODING_DEFAULT

STATIC_REPOSITORIES

repository

コンストラクタの詳細

StringResourceLoader

メソッドの詳細

getRepository

getRepository

setRepository

removeRepository

clearRepositories

init

createRepository

getResourceStream

isSourceModified

getLastModified