|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProducerAgent
This interface is provided for discovering a producer and setting up from a consumer from stand-alone clients.
This interface does not support WS-Security policies. To perform similar operations from a
portal consumer web application or other web based tools like Portal Administration tools,
use the ProducerManager
. ProducerManager
does support security.
ProducerManager
Nested Class Summary | |
---|---|
static class |
ProducerAgent.Factory
A ProducerAgent factory. |
Method Summary | |
---|---|
void |
deregister(String wsdlUrl,
IRegistrationContext registrationContext)
Deregisters with the given producer. |
IPortletDescription |
getPortletDescription(String wsdlUrl,
IRegistrationContext registrationContext,
String portletHandle)
Returns the description of the portlet identitified by the given portletHandle. |
IPortletDescription |
getPortletDescription(String wsdlUrl,
IRegistrationContext registrationContext,
String portletHandle,
byte[] portletState)
Returns the description of the portlet identitified by the given portletHandle. |
IServiceDescription |
getServiceDescription(String wsdlUrl,
IRegistrationContext registrationContext)
Returns the service description given the producer's WSDL URL. |
IRegistrationContext |
modifyRegistration(String wsdlUrl,
IRegistrationContext registrationContext,
String consumerName,
String consumerAgent,
Map<String,Object> registrationProperties,
String[] customUserProperties)
Modifies an existing registration with the given producer. |
IRegistrationContext |
register(String wsdlUrl,
String consumerName,
String consumerAgent,
Map<String,?> registrationProperties,
String[] customUserProperties)
Registers with the given producer. |
Method Detail |
---|
IServiceDescription getServiceDescription(String wsdlUrl, IRegistrationContext registrationContext) throws InvalidRegistrationException, OperationFailedException, IOException
Returns the service description given the producer's WSDL URL. If the consumer is registered, supply the registration context.
wsdlUrl
- WSDL URL of the producerregistrationContext
- registration context. Supply null if the consumer is not registered.
InvalidRegistrationException
- thrown when the supplied registration context is not valid.
OperationFailedException
- throw when the producer is unable to process the request.
IOException
IPortletDescription getPortletDescription(String wsdlUrl, IRegistrationContext registrationContext, String portletHandle) throws InvalidRegistrationException, OperationFailedException, InvalidHandleException, IOException
Returns the description of the portlet identitified by the given portletHandle.
wsdlUrl
- Producer's WSDL URLregistrationContext
- registration context. Supply null if the consumer is not registered.portletHandle
- portlet handle
InvalidRegistrationException
- thrown when the supplied registration context is not valid.
OperationFailedException
- throw when the producer is unable to process the request.
InvalidHandleException
IOException
IPortletDescription getPortletDescription(String wsdlUrl, IRegistrationContext registrationContext, String portletHandle, byte[] portletState) throws InvalidRegistrationException, OperationFailedException, InvalidHandleException, IOException
Returns the description of the portlet identitified by the given portletHandle.
wsdlUrl
- Producer's WSDL URLregistrationContext
- registration context. Supply null if the consumer is not registered.portletHandle
- portlet handleportletState
- The portlet's state (may be null)
InvalidRegistrationException
- thrown when the supplied registration context is not valid.
OperationFailedException
- throw when the producer is unable to process the request.
InvalidHandleException
IOException
IRegistrationContext register(String wsdlUrl, String consumerName, String consumerAgent, Map<String,?> registrationProperties, String[] customUserProperties) throws MissingParametersException, OperationFailedException, IOException
Registers with the given producer.
wsdlUrl
- WSDL URL of the producerconsumerName
- consumer nameconsumerAgent
- consumer agentregistrationProperties
- Registration properties. If the producer does not require registration,
or if the consumer is unable to supply any registration properties, supply a null or an empty map.
The registration properties must be of type specified by the producer via
IRegistrationPropertyDescription
MissingParametersException
- throw when certain registration properties are missing.
OperationFailedException
- throw when the producer is unable to process the request.
IOException
IRegistrationPropertyDescription
void deregister(String wsdlUrl, IRegistrationContext registrationContext) throws InvalidRegistrationException, OperationFailedException, IOException
Deregisters with the given producer. For this operation to succeed, the given registration context must be valid.
wsdlUrl
- WSDL URL of the producerregistrationContext
- current registration context
InvalidRegistrationException
- thrown when the supplied registration context is not valid.
OperationFailedException
- throw when the producer is unable to process the request.
IOException
IRegistrationContext modifyRegistration(String wsdlUrl, IRegistrationContext registrationContext, String consumerName, String consumerAgent, Map<String,Object> registrationProperties, String[] customUserProperties) throws InvalidRegistrationException, MissingParametersException, OperationFailedException, IOException
Modifies an existing registration with the given producer. The given registration context must be valid for this operation to succeed.
wsdlUrl
- WSDL URL of the producerregistrationContext
- current registration contextregistrationProperties
- new/modified registration properties
InvalidRegistrationException
- thrown when the supplied registration context is not valid.
MissingParametersException
- throw when certain registration properties are missing.
OperationFailedException
- throw when the producer is unable to process the request.
IOException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |