All Superinterfaces:

edu.uiuc.ncsa.security.core.Logable

All Known Implementing Classes:

OA2SE, ServiceEnvironmentImpl
```
public interface ServiceEnvironment
extends edu.uiuc.ncsa.security.core.Logable
```
This interface has the instances of various stores and other configurable information in it.
Created by Jeff Gaynor
on 4/13/12 at 10:40 AM

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AdminClientStore<AdminClient>`	`getAdminClientStore()`	Returns the `AdminClientStore`.
`AGIssuer`	`getAgIssuer()`	The `AbstractIssuer` that creates `edu.uiuc.ncsa.security.delegation.token.AuthorizationGrant`s.
`ATIssuer`	`getAtIssuer()`	The `AbstractIssuer` that creates `edu.uiuc.ncsa.security.delegation.token.AccessToken`s.
`AuthorizationServletConfig`	`getAuthorizationServletConfig()`
`ClientApprovalStore<ClientApproval>`	`getClientApprovalStore()`	returns the client approval store.
`ClientStore<Client>`	`getClientStore()`	Returns the current `ClientStore`.
`Map<String,String>`	`getConstants()`
`KeyPair`	`getKeyPair()`	Return a key pair for cert request generation, e.g.
`edu.uiuc.ncsa.security.util.mail.MailUtil`	`getMailUtil()`	Returns the mail utility which, when configured, will send notifications for requests.
`int`	`getMaxAllowedNewClientRequests()`
`Map<String,String>`	`getMessages()`	Messages which may be displayed to the user, e.g., when authentication fails.
`List<MyProxyServiceFacade>`	`getMyProxyServices()`	List of known MyProxy servers.
`PAIssuer`	`getPaIssuer()`	The `AbstractIssuer` that creates the `edu.uiuc.ncsa.security.delegation.token.ProtectedAsset`s.
`URI`	`getServiceAddress()`	The address for this server.
`TokenForge`	`getTokenForge()`	The forge that creates delegation tokens for this service.
`TransactionStore<ServiceTransaction>`	`getTransactionStore()`	Returns the current transaction store.
`edu.uiuc.ncsa.security.servlet.UsernameTransformer`	`getUsernameTransformer()`
`boolean`	`isPingable()`
`List<edu.uiuc.ncsa.security.core.Store>`	`listStores()`	List the current stores in this environment.
`void`	`setServiceAddress(URI serviceAddress)`
`void`	`setUsernameTransformer(edu.uiuc.ncsa.security.servlet.UsernameTransformer usernameTransformer)`

Methods inherited from interface edu.uiuc.ncsa.security.core.Logable
debug, error, info, isDebugOn, setDebugOn, warn

- Method Detail
  - getAuthorizationServletConfig
```
AuthorizationServletConfig getAuthorizationServletConfig()
```
  - getKeyPair
```
KeyPair getKeyPair()
```
    Return a key pair for cert request generation, e.g. in limited proxy requests.
    
    Returns:
  - getConstants
```
Map<String,String> getConstants()
```
  - getMessages
```
Map<String,String> getMessages()
```
    Messages which may be displayed to the user, e.g., when authentication fails.
    
    Returns:
  - getTransactionStore
```
TransactionStore<ServiceTransaction> getTransactionStore()
```
    Returns the current transaction store.
    
    Returns:
  - getMyProxyServices
```
List<MyProxyServiceFacade> getMyProxyServices()
```
    List of known MyProxy servers. This list will be tried in order until either an operation] succeeds or there is a GeneralSecurityException. Other exceptions (such as network issues) are ignored.
    
    Returns:
  - getServiceAddress
```
URI getServiceAddress()
```
    The address for this server. Since hosts can have any of several aliases, automatic determination from the servlet is usually a bad idea.
    
    Returns:
  - setServiceAddress
```
void setServiceAddress(URI serviceAddress)
```
  - getTokenForge
```
TokenForge getTokenForge()
```
    The forge that creates delegation tokens for this service.
    
    Returns:
  - getAgIssuer
```
AGIssuer getAgIssuer()
```
    The AbstractIssuer that creates edu.uiuc.ncsa.security.delegation.token.AuthorizationGrants.
    
    Returns:
  - getAtIssuer
```
ATIssuer getAtIssuer()
```
    The AbstractIssuer that creates edu.uiuc.ncsa.security.delegation.token.AccessTokens.
    
    Returns:
  - getPaIssuer
```
PAIssuer getPaIssuer()
```
    The AbstractIssuer that creates the edu.uiuc.ncsa.security.delegation.token.ProtectedAssets.
    
    Returns:
  - getClientStore
```
ClientStore<Client> getClientStore()
```
    Returns the current ClientStore.
    
    Returns:
  - getAdminClientStore
```
AdminClientStore<AdminClient> getAdminClientStore()
```
    Returns the AdminClientStore.
    
    Returns:
  - getClientApprovalStore
```
ClientApprovalStore<ClientApproval> getClientApprovalStore()
```
    returns the client approval store.
    
    Returns:
  - getMailUtil
```
edu.uiuc.ncsa.security.util.mail.MailUtil getMailUtil()
```
    Returns the mail utility which, when configured, will send notifications for requests.
    
    Returns:
  - getMaxAllowedNewClientRequests
```
int getMaxAllowedNewClientRequests()
```
  - getUsernameTransformer
```
edu.uiuc.ncsa.security.servlet.UsernameTransformer getUsernameTransformer()
```
  - setUsernameTransformer
```
void setUsernameTransformer(edu.uiuc.ncsa.security.servlet.UsernameTransformer usernameTransformer)
```
  - isPingable
```
boolean isPingable()
```
  - listStores
```
List<edu.uiuc.ncsa.security.core.Store> listStores()
```
    List the current stores in this environment. Used at bootstrapping for various types of introspection.
    
    Returns:

Interface ServiceEnvironment

Method Summary

Methods inherited from interface edu.uiuc.ncsa.security.core.Logable

Method Detail

getAuthorizationServletConfig

getKeyPair

getConstants

getMessages

getTransactionStore

getMyProxyServices

getServiceAddress

setServiceAddress

getTokenForge

getAgIssuer

getAtIssuer

getPaIssuer

getClientStore

getAdminClientStore

getClientApprovalStore

getMailUtil

getMaxAllowedNewClientRequests

getUsernameTransformer

setUsernameTransformer

isPingable

listStores