|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.shibboleth.common.config.BaseService
edu.internet2.middleware.shibboleth.common.config.BaseReloadableService
edu.internet2.middleware.ldappc.spml.provider.BaseSpmlProvider
public abstract class BaseSpmlProvider
Base class for SPMLv2 Provisioning Service Providers. Handling of requests is provided
by subclasses. Extends Shibboleth's BaseReloadableService.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class edu.internet2.middleware.shibboleth.common.config.BaseReloadableService |
|---|
edu.internet2.middleware.shibboleth.common.config.BaseReloadableService.ConfigurationResourceListener |
| Field Summary | |
|---|---|
static String |
methodName
Method name to look for in subclasses. |
| Constructor Summary | |
|---|---|
BaseSpmlProvider()
|
|
| Method Summary | |
|---|---|
org.openspml.v2.msg.spml.Response |
execute(org.openspml.v2.msg.spml.Request request)
Execute a Request and return the Response. |
org.openspml.v2.msg.spml.Response |
fail(org.openspml.v2.msg.spml.Response response,
org.openspml.v2.msg.spml.ErrorCode errorCode,
Exception e)
See fail(Response, ErrorCode, String...)
The messages from the given exception are added to the response. |
org.openspml.v2.msg.spml.Response |
fail(org.openspml.v2.msg.spml.Response response,
org.openspml.v2.msg.spml.ErrorCode errorCode,
String... messages)
Set the status code of the given response to failure and set the error code and messages. |
String |
generateRequestID()
Generate a reasonably unique id. |
String |
getId()
|
String |
getOrGenerateRequestID(org.openspml.v2.msg.spml.Request request)
Return the request ID of the given request or generate a new request ID. |
org.openspml.v2.msg.XMLMarshaller |
getXMLMarshaller()
Return the XML marshaller, which will be instantiated once and reused per instance of this class. |
org.openspml.v2.msg.XMLUnmarshaller |
getXmlUnmarshaller()
Return the XML unmarshaller, which will be instantiated once and reused per instance of this class. |
void |
setId(String id)
Sets the id. |
void |
setXMLMarshaller(org.openspml.v2.msg.XMLMarshaller xmlMarshaller)
Set the XML marshaller |
void |
setXmlUnmarshaller(org.openspml.v2.msg.XMLUnmarshaller xmlUnmarshaller)
Set the XML unmarshaller |
String |
toXML(org.openspml.v2.msg.Marshallable marshallable)
Return the XML representation of the given object. |
| Methods inherited from class edu.internet2.middleware.shibboleth.common.config.BaseReloadableService |
|---|
destroy, getPollingFrequency, getPollingRetryAttempts, getPollingTimer, initialize, reload, setPollingFrequency, setPollingRetryAttempts, setPollingTimer |
| Methods inherited from class edu.internet2.middleware.shibboleth.common.config.BaseService |
|---|
getApplicationContext, getReadWriteLock, getServiceConfigurations, getServiceContext, isDestroyed, isInitialized, loadContext, onNewContextCreated, setApplicationContext, setBeanName, setInitialized, setServiceConfigurations, setServiceContext |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface edu.internet2.middleware.shibboleth.common.service.Service |
|---|
isDestroyed, isInitialized |
| Field Detail |
|---|
public static final String methodName
| Constructor Detail |
|---|
public BaseSpmlProvider()
| Method Detail |
|---|
public org.openspml.v2.msg.spml.Response execute(org.openspml.v2.msg.spml.Request request)
Request and return the Response.
Only the synchronous execution mode is supported.
execute in interface SpmlProviderrequest - the SPML request
public String getId()
getId in interface edu.internet2.middleware.shibboleth.common.service.ServicegetId in class edu.internet2.middleware.shibboleth.common.config.BaseServicepublic void setId(String id)
id - public org.openspml.v2.msg.XMLMarshaller getXMLMarshaller()
XMLMarshallerpublic void setXMLMarshaller(org.openspml.v2.msg.XMLMarshaller xmlMarshaller)
xmlMarshaller - the XMLMarshallerpublic org.openspml.v2.msg.XMLUnmarshaller getXmlUnmarshaller()
XMLUnmarshallerpublic void setXmlUnmarshaller(org.openspml.v2.msg.XMLUnmarshaller xmlUnmarshaller)
xmlUnmarshaller - the XMLUnmarshaller
public org.openspml.v2.msg.spml.Response fail(org.openspml.v2.msg.spml.Response response,
org.openspml.v2.msg.spml.ErrorCode errorCode,
Exception e)
fail(Response, ErrorCode, String...)
The messages from the given exception are added to the response.
response - the ResponseerrorCode - the ErrorCodee - the exception
Response
public org.openspml.v2.msg.spml.Response fail(org.openspml.v2.msg.spml.Response response,
org.openspml.v2.msg.spml.ErrorCode errorCode,
String... messages)
response - the ResponseerrorCode - the ErrorCodemessages - error text
Responsepublic String generateRequestID()
PSPUtil.uniqueRequestId()
public String getOrGenerateRequestID(org.openspml.v2.msg.spml.Request request)
request -
public String toXML(org.openspml.v2.msg.Marshallable marshallable)
marshallable - the Marshallable object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||