public interface CentraSiteService
CentraSiteSession
,
which is the entry point for getting instances of managers like:
CentraSiteServiceFactory
.
CentraSiteService centraSiteService = CentraSiteServiceFactory.createService(); CentraSiteService centraSiteService = CentraSiteServiceFactory.createService(String baseDir); CentraSiteService centraSiteService = CentraSiteServiceFactory.createService(Properties properties);
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes a service and releases all resources.
|
CentraSiteSession |
createSession()
Creates an anonymous session that is mapped to guest access. if Guest
access can be disabled which results that this method will return null.
|
CentraSiteSession |
createSession(java.util.Collection<java.lang.Object> authentication)
Creates a session based on the passed authentication information which
can be Password authentication or SSO information.
|
CentraSiteSession |
createSession(java.util.Collection<java.lang.Object> authenticationList,
com.softwareag.centrasite.inmconfiguration.v2.ITomcatSettings tomcatSettings)
Creates a session based on the passed authentication information which
can be Password authentication or SSO information.
|
CentraSiteSession |
createSession(java.util.Collection<java.lang.Object> authentication,
java.lang.String dbUrl)
Creates a session based on the passed authentication information which
can be Password authentication or SSO information.
|
CentraSiteSession |
createSession(javax.servlet.http.HttpServletRequest request,
com.softwareag.centrasite.inmconfiguration.v2.ITomcatSettings tomcatSettings)
Creates a session based on the HTTP servlet request and the Tomcat settings.
|
CentraSiteSession |
createSession(com.softwareag.centrasite.inmconfiguration.v2.ITomcatSettings tomcatSettings)
Creates an anonymous session that is mapped to guest access. if Guest
access can be disabled which results that this method will return null.
|
Configurator |
getConfigurator()
Returns the default System Configurator.
|
java.lang.String |
getDbUrl()
Get the database URL configured by the installer.
|
DiagnosticHandler |
getDiagnosticHandler()
Instantiate the DiagnosticHandler, which is used to notify the diagnostics to the user in case exception occurred during the execution..
|
java.lang.String |
getGuestUserLocale()
This method return the guest user locale.
|
boolean |
isActiveSoaEdition()
Return whether the server has an ActiveSoaEdition license.
|
java.lang.String |
requestAccount(java.util.Map<java.lang.Object,java.lang.Object> userInfoMap)
Request for a new CentraSite account.
|
void |
requestAccount(OnboardingRequest req)
Request a new account request by delegating the request to privileged service.
|
CentraSiteSession createSession() throws CLLException
CentraSiteSession
for the guest user access
if the guest user access is disabled then this method return null.CLLException
- If a CentraSite session cannot be createdCentraSiteSession createSession(com.softwareag.centrasite.inmconfiguration.v2.ITomcatSettings tomcatSettings) throws CLLException
tomcatSettings
- ITomcatSettings
- the Software AG Tomcat Server settings to be used in
INMConfigurationCentraSiteSession
for the guest user access
if the guest user access is disabled then this method return null.CLLException
- If a CentraSite session cannot be createdCentraSiteSession createSession(java.util.Collection<java.lang.Object> authentication) throws CLLException
authentication
- in case the authentication is password based authentication ,
this expects java.net.PasswordAutentication object as
parameterCentraSiteSession
mapped to the user passed parameter.CLLException
- If a CentraSite session cannot be createdCentraSiteSession createSession(java.util.Collection<java.lang.Object> authentication, java.lang.String dbUrl) throws CLLException
authentication
- in case the authentication is password based authentication ,
this expects java.net.PasswordAutentication object as
parameterdbURL
- CentraSiteSession
mapped to the user passed parameter.CLLException
- If a CentraSite session cannot be createdCentraSiteSession createSession(java.util.Collection<java.lang.Object> authenticationList, com.softwareag.centrasite.inmconfiguration.v2.ITomcatSettings tomcatSettings) throws CLLException
authenticationList
- in case the authentication is password based authentication ,
this expects java.net.PasswordAutentication object as
parametertomcatSettings
- the Software AG Tomcat Server settings to be used in
INMConfigurationCentraSiteSession
mapped to the user passed parameter.CLLException
- If a CentraSite session cannot be createdCentraSiteSession createSession(javax.servlet.http.HttpServletRequest request, com.softwareag.centrasite.inmconfiguration.v2.ITomcatSettings tomcatSettings) throws CLLException
request
- The HttpServletRequest
for the sessiontomcatSettings
- ITomcatSettings
- the Software AG Tomcat Server settings to be used in
INMConfigurationCentraSiteSession
mapped to the user passed parameter.CLLException
- If a CentraSite session cannot be createdDiagnosticHandler getDiagnosticHandler() throws CLLException
DiagnosticHandler
.CLLException
- If the diagnostic handler instance cannot be obtained due to an errorjava.lang.String getGuestUserLocale() throws CLLException
CLLException
- If an error occurs in obtaining the guest user's localeConfigurator getConfigurator() throws CLLException
CLLException
- If an error occurs in getting the default system configuratorvoid close() throws CLLException
CLLException
- If all resources cannot be releasedjava.lang.String requestAccount(java.util.Map<java.lang.Object,java.lang.Object> userInfoMap) throws CLLException
userInfoMap
- A map containing values for UserEmail, FirstName, LastName, ReasonforRequest.
HashMap
CLLException
- If an error occurs while creating the account requestboolean isActiveSoaEdition() throws CLLException
CLLException
- If an error occurs while checking the licensevoid requestAccount(OnboardingRequest req) throws CLLException
req
- OnboardingRequest
object which contains the details like firstname,
lastname, email, password, etc.,CLLException
- If an error occurs in constructing the requestjava.lang.String getDbUrl() throws CLLException
CLLException
- If an error occurs while fetching the database URL.