|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.ProviderDefinition oracle.portal.provider.v2.DefaultProviderDefinition
public class DefaultProviderDefinition
DefaultProviderDefinition
extends the base
ProviderDefinition
meta data class with a set of accessors
compatible with the DefaultProviderLoader
mechanism that loads
provider definitions from XML files. This is the class most commonly used in
the PDK-Java samples to define a provider.
Constructor Summary | |
---|---|
DefaultProviderDefinition()
|
Method Summary | |
---|---|
void |
addContainerRenderer(java.lang.Object renderer)
Sets the default portlet container renderer. |
void |
addPortlet(java.lang.Object portlet)
Associates with the provider a PortletDefinition object
containing the meta data for one of the portlets it owns. |
void |
addPreferenceStore(java.lang.Object ps)
Adds to the set of PreferenceStore objects that may be used by
the provider for persistent storage. |
void |
postInitialize()
Should be called once initialization of this DefaultProviderDefinition is complete, to complete
initialization and perform any necessary validation. |
void |
preInitialize(java.lang.Object parent)
Should be called immediately after construction of a DefaultProviderDefinition to associate it with its parent
ProviderContext object describing its deployment
environment. |
void |
setCacheLevel(java.lang.String cacheLevel)
Sets the caching level used for portlet render requests for portlets belonging to this provider. |
void |
setCipherManager(java.lang.Object cipherManager)
Sets the the CipherManager
which will be employed to encrypt exported data and decrypt imported
data. |
void |
setDefaultLocale(java.lang.String defaultLocale)
Sets the default Locale for this ProviderDefinition . |
void |
setLocalePersonalizationLevel(java.lang.String value)
Sets the locale personalization level which will be used for portlets whose defintion does not include a portlet specific setting. |
void |
setPassAllUrlParams(java.lang.String value)
Controls whether Portal will pass the requested page's URL parameters to the provider's portlets by default. |
void |
setProviderBuilder(java.lang.Object providerBuilder)
Each provider can specifiy the builder attached to edit this provider. |
void |
setProviderInstanceClass(java.lang.String className)
Defines the ProviderInstance subclass that implements the
provider's behaviour. |
void |
setRewriteUrls(java.lang.String value)
Controls whether or not URL rewriting will be performed on the results of portlet render requests for portlets belonging to this provider. |
void |
setSession(java.lang.String session)
Controls whether the ProviderInstance starts a (servlet)
session in its ProviderInstance.initSession(oracle.portal.provider.v2.ProviderUser, oracle.portal.provider.v2.externalApp.ExternalPrincipal) method. |
void |
setUseOldStyleHeaders(java.lang.String useOldStyleHeaders)
Deprecated. use addContainerRenderer(java.lang.Object) with ContainerRenderer306 to get equivalent
behavior. Alternatively, create your own container renderer by extending
PortletContainerRenderer |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultProviderDefinition()
Method Detail |
---|
public void setProviderInstanceClass(java.lang.String className) throws java.lang.ClassNotFoundException
ProviderInstance
subclass that implements the
provider's behaviour.
className
- the fully qualified name of the ProviderInstance
class or subclass that implements the provider's
behaviour.
java.lang.ClassNotFoundException
public void setSession(java.lang.String session)
ProviderInstance
starts a (servlet)
session in its ProviderInstance.initSession(oracle.portal.provider.v2.ProviderUser, oracle.portal.provider.v2.externalApp.ExternalPrincipal)
method.
session
- String representation of boolean value. Should be
"true"
if this provider is to start a session in
initSession
, or "false"
otherwise.public void setUseOldStyleHeaders(java.lang.String useOldStyleHeaders)
addContainerRenderer(java.lang.Object)
with ContainerRenderer306
to get equivalent
behavior. Alternatively, create your own container renderer by extending
PortletContainerRenderer
PortletRendererUtil
should render
headers and footers for this provider's portlets in the style used by a
3.0.6 portal or earlier, rather than the style used by a post-3.0.6
portal.
useOldStyleHeaders
- String representation of boolean ("true"
or
"false"
) indicating which style of form headers and footers should be
rendered by PortletRendererUtil
.ProviderDefinition.setUseOldStyleHeaders(boolean)
public void addContainerRenderer(java.lang.Object renderer) throws ProviderException
The container renderer is responsible for rendering the portlet container in each of the show modes the portlet supports.
Each portlet can specify its own container renderer and you can specify a default at the provider level to be used by any portlet that does not explicitly specify it's own container renderer.
Note: This method uses the "add" prefix instead of "set" to prevent ambiguous method errors during compilation. Calling the parent method using "super" could be used within this class to resolve the ambiguity, but if you are calling this method on an instance of DefaultProviderDefinition you cannot use that technique to resolve it.
renderer
- the default portlet container renderer. Even though the
type of the parameter is Object, the parameter must be an instance of
PortletContainerRenderer
ProviderException
- if the given object is not a valid
PortletContainerRenderer
.public void setPassAllUrlParams(java.lang.String value)
value
- String representation of a boolean value indicating whether
Portal will pass the requested page's URL parameters to portlets by
default.
"true"
, then each portlet whose definition doesn't
explicitly override this setting will receive all the
(non-system) parameters from the page URL."false"
(the default), then each portlet which
declares input parameters and doesn't explicitly override this
setting (with PortletDefinition.setPassAllUrlParams(boolean)
)
will only receive values for its declared input parameters and
private parameters which have been generated using PortletRendererUtil.portletParameter(oracle.portal.provider.v2.render.PortletRenderRequest, java.lang.String)
. The
parameter values will be determined by the usage of the portlet
on a particular page.public void setCacheLevel(java.lang.String cacheLevel) throws ProviderException
session
: both user and portal session information
is required.
user
: user information is required but no session
information is required.
system
: neither user information nor portal session
information is required.
cacheLevel
- int indicates the caching level - should be one of
PortletConstants.CACHE_LEVEL_SYSTEM_STR,
PortletConstants.CACHE_LEVEL_USER_STR, or
PortletConstants.CACHE_LEVEL_SESSION_STR.
The cache level for a portlet render request is determined using
the following order of precedence:
ProviderException
public void setRewriteUrls(java.lang.String value)
value
- value "true" if URL rewriting is to be performed.
Otherwise "false".ProviderDefinition.setRewriteUrls(boolean)
,
PortletDefinition.setRewriteUrls(boolean)
public void setLocalePersonalizationLevel(java.lang.String value) throws ProviderException
PortletDefinition.setLocalePersonalizationLevel(int)
.
value
- the required locale personalization level. See,
DefaultPortletDefinition.setLocalePersonalizationLevel(String)
ProviderException
public void setDefaultLocale(java.lang.String defaultLocale)
ProviderDefinition
. The Locale
is specified using the standard ISO two-letter language and country
codes, e.g. en.US
. See ProviderDefinition.setDefaultLocale(Locale)
.
defaultLocale
- a String specifying a Localepublic void addPortlet(java.lang.Object portlet) throws ProviderException
PortletDefinition
object
containing the meta data for one of the portlets it owns. Note that each
PortletDefinition
added should have a unique id.
portlet
- an object containing the portlet-level meta data for one
of the provider's portlets. Should be a PortletDefinition
or a
subclass.
ProviderException
- if the given object is not a
PortletDefinition
public void addPreferenceStore(java.lang.Object ps) throws ProviderException
PreferenceStore
objects that may be used by
the provider for persistent storage. Note that each
PreferenceStore
added should have a unique identifying
name.
ps
- a preference store object. Should be a PreferenceStore
or subclass.
ProviderException
- if the given object is not a
PreferenceStore
public void setCipherManager(java.lang.Object cipherManager) throws ProviderException
CipherManager
which will be employed to encrypt exported data and decrypt imported
data. A null value indicates that exported data will not be encrypted.
The ProviderDefinition
level cipher manager serves as the
default for all contained portlets.
cipherManager
- an object of type CipherManager
which will be
employed to encrypt exported data and decrypt imported data.
ProviderException
public void preInitialize(java.lang.Object parent) throws NodeHandlerException
DefaultProviderDefinition
to associate it with its parent
ProviderContext
object describing its deployment
environment. Generally, all providers running in the same environment
(e.g. within the same adapter servlet) share the same
ProviderContext
.
preInitialize
in interface InitializableXMLObject
parent
- an object describing the deployment environment of the
provider. Should be a ProviderContext
.
NodeHandlerException
- if the given object is not a
ProviderContext
public void postInitialize() throws NodeHandlerException
DefaultProviderDefinition
is complete, to complete
initialization and perform any necessary validation.
postInitialize
in interface InitializableXMLObject
NodeHandlerException
- if validation is unsuccessfulpublic void setProviderBuilder(java.lang.Object providerBuilder) throws ProviderException
providerBuilder
- the ProviderBuilder attribute for this Provider
ProviderException
- if the given Object is not a valid BuilderMetaData
.
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |