Package org.oa4mp.server.api
Interface ServiceEnvironment
-
- All Superinterfaces:
edu.uiuc.ncsa.security.core.Logable
- All Known Implementing Classes:
ServiceEnvironmentImpl
public interface ServiceEnvironment extends edu.uiuc.ncsa.security.core.LogableThis 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 theAdminClientStore.AGIssuergetAgIssuer()TheAbstractIssuerthat createsAuthorizationGrants.ATIssuergetAtIssuer()TheAbstractIssuerthat createsAccessTokens.AuthorizationServletConfiggetAuthorizationServletConfig()ClientApprovalStore<ClientApproval>getClientApprovalStore()returns the client approval store.ClientStore<org.oa4mp.delegation.common.storage.clients.Client>getClientStore()Returns the currentClientStore.Map<String,String>getConstants()KeyPairgetKeyPair()Return a key pair for cert request generation, e.g. in limited proxy requests.edu.uiuc.ncsa.security.util.mail.MailUtilgetMailUtil()Returns the mail utility which, when configured, will send notifications for requests.intgetMaxAllowedNewClientRequests()Map<String,String>getMessages()Messages which may be displayed to the user, e.g., when authentication fails.PAIssuergetPaIssuer()TheAbstractIssuerthat creates theProtectedAssets.PermissionsStore<Permission>getPermissionStore()URIgetServiceAddress()The address for this server.org.oa4mp.delegation.common.token.TokenForgegetTokenForge()The forge that creates delegation tokens for this service.org.oa4mp.delegation.common.storage.TransactionStore<ServiceTransaction>getTransactionStore()Returns the current transaction store.edu.uiuc.ncsa.security.servlet.UsernameTransformergetUsernameTransformer()booleanhasAuthorizationServletConfig()booleanisPingable()List<edu.uiuc.ncsa.security.core.Store>listStores()List the current stores in this environment.voidsetServiceAddress(URI serviceAddress)voidsetUsernameTransformer(edu.uiuc.ncsa.security.servlet.UsernameTransformer usernameTransformer)
-
-
-
Method Detail
-
getAuthorizationServletConfig
AuthorizationServletConfig getAuthorizationServletConfig()
-
hasAuthorizationServletConfig
boolean hasAuthorizationServletConfig()
-
getKeyPair
KeyPair getKeyPair()
Return a key pair for cert request generation, e.g. in limited proxy requests.- Returns:
-
getMessages
Map<String,String> getMessages()
Messages which may be displayed to the user, e.g., when authentication fails.- Returns:
-
getTransactionStore
org.oa4mp.delegation.common.storage.TransactionStore<ServiceTransaction> getTransactionStore()
Returns the current transaction store.- 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
org.oa4mp.delegation.common.token.TokenForge getTokenForge()
The forge that creates delegation tokens for this service.- Returns:
-
getAgIssuer
AGIssuer getAgIssuer()
TheAbstractIssuerthat createsAuthorizationGrants.- Returns:
-
getAtIssuer
ATIssuer getAtIssuer()
TheAbstractIssuerthat createsAccessTokens.- Returns:
-
getPaIssuer
PAIssuer getPaIssuer()
TheAbstractIssuerthat creates theProtectedAssets.- Returns:
-
getClientStore
ClientStore<org.oa4mp.delegation.common.storage.clients.Client> getClientStore()
Returns the currentClientStore.- Returns:
-
getAdminClientStore
AdminClientStore<AdminClient> getAdminClientStore()
Returns theAdminClientStore.- 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:
-
getPermissionStore
PermissionsStore<Permission> getPermissionStore()
-
-