com.oracle.producer.spi
Interface IConfigurationContext

public interface IConfigurationContext

Allows access to producer configuration information. The producer is responsible for providing the implementation of this class.

Nested Class Summary

static class

IConfigurationContext.WsrpFault

Method Summary

WSRPFaultException	createWsrpFaultException(IConfigurationContext.WsrpFault fault, String message, Throwable cause) Creates an exception for a specific WSRP fault.
Map<String,String[]>	getPOPPreferenceValues(String popHandle) Returns an unmodifiable map of the preference values defined for the specified POP portlet.
String	getProducerName() Gets a unique handle for the producer.
javax.servlet.ServletConfig	getServletConfig() Gets the servlet configuration.
boolean	isPOPHandleValid(String popHandle) Returns true if the specified portlet POP handle is valid.
boolean	isPreferenceReadOnly(String preferenceKey, String popHandle) Returns true if the specified preference is read-only for the specified POP portlet.

Method Detail

getServletConfig

javax.servlet.ServletConfig getServletConfig()

Gets the servlet configuration.

getProducerName

String getProducerName()

Gets a unique handle for the producer. This may be useful if multiple producers are sharing the same backing data store, such as a database.

isPOPHandleValid

boolean isPOPHandleValid(String popHandle)

Returns true if the specified portlet POP handle is valid.

getPOPPreferenceValues

Map<String,String[]> getPOPPreferenceValues(String popHandle)

Returns an unmodifiable map of the preference values defined for the specified POP portlet. Will never return null, even if the POP handle is invalid an empty map will be returned.

isPreferenceReadOnly

boolean isPreferenceReadOnly(String preferenceKey,
                             String popHandle)

Returns true if the specified preference is read-only for the specified POP portlet.

createWsrpFaultException

WSRPFaultException createWsrpFaultException(IConfigurationContext.WsrpFault fault,
                                            String message,
                                            Throwable cause)

Creates an exception for a specific WSRP fault.

Parameters

fault - the WSRP fault.

message - the message for the exception.

cause - the underlying cause, if any.