|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTWebService
This interface wraps access to a specific web service instance. A web service object contains common settings and methods used by all types of web services in the portal, including portlets, AWS, CWS, SWS, PWS, etc.
IPTGadgetContentServer
Method Summary | |
---|---|
java.lang.Object |
CreateHTTPRequest(java.lang.Object pHttpSession,
java.lang.Object pURL)
Creates IOKHttpRequest based on IOKHttpSession, IOKUrl, and http tracing parameters. |
java.lang.String |
GetAbsoluteURL(java.lang.String bstrSettingName)
Constructs an absolute URL relative to the remote server base URL from a ProviderInfo setting. |
int |
GetCardSubmitType()
Gets the type of CardSubmission a web service supports. |
java.lang.String |
GetDisabledMessage()
Get the message to show when the web service has been disabled. |
boolean |
GetEnabled()
Get the status of the web service, enabled or disabled. |
java.lang.String |
GetProviderCLSID()
Needed by Web Service Editor to support Web Service types. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetProviderInfo()
Get additional provider-specific settings. |
int |
GetRemoteServerID()
Get the remote server associated with this web service. |
int |
GetSupportsPersonalization()
Flag set by the web service creator that indicates whether or not this web service allows personalization. |
boolean |
GetSupportsUserInterface(java.lang.String bstrUserInterfaceName)
Indicates whether this web service supports a particular user interface. |
java.lang.Object[] |
GetUserInterfaces()
Gets the UserInterfaces a web service supports. |
void |
SetCardSubmitType(int Value)
Sets the type of CardSubmission a web service supports. |
void |
SetDisabledMessage(java.lang.String Value)
Set the message to show when the web service has been disabled. |
void |
SetEnabled(boolean Value)
Set the status of the web service, enabled or disabled. |
void |
SetProviderCLSID(java.lang.String Value)
Needed by Web Service Editor to support Web Service types. |
void |
SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Set additional provider-specific settings. |
void |
SetProviderInfo(java.lang.String Value)
Set additional provider-specific settings. |
void |
SetRemoteServerID(int Value)
Set the remote server associated with this web service. |
void |
SetSupportsPersonalization(int Value)
Flag set by the web service creator that indicates whether or not this web service allows personalization. |
void |
SetupHTTPRequest(java.lang.Object pHttpRequestParallel,
IPTSSOInfo pSSOInfo)
Sets the basic auth headers on an IPTHttpRequestParallel. |
void |
SetUserInterfaces(java.lang.Object[] Value)
Deprecated. |
void |
SetUserInterfaces(java.lang.String[] Value)
Sets the UserInterfaces a web service supports. |
Methods inherited from interface com.plumtree.server.IPTObject |
---|
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified |
Methods inherited from interface com.plumtree.server.IPTLocalizable |
---|
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang |
Methods inherited from interface com.plumtree.server.IPTUnknown |
---|
GetInterfaces |
Methods inherited from interface com.plumtree.server.IPTServerContext |
---|
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject |
Methods inherited from interface com.plumtree.server.IPTStorable |
---|
Store |
Method Detail |
---|
boolean GetEnabled()
void SetEnabled(boolean Value)
Value
- true if enabled.java.lang.String GetDisabledMessage()
void SetDisabledMessage(java.lang.String Value)
Value
- the message.com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Value
- the format varies by provider.void SetProviderInfo(java.lang.String Value)
Value
- a property bag serialized to XML.int GetRemoteServerID()
void SetRemoteServerID(int Value)
Value
- the ID of a remote server object.java.lang.Object[] GetUserInterfaces()
void SetUserInterfaces(java.lang.String[] Value)
Value
- array of user interface URIs.void SetUserInterfaces(java.lang.Object[] Value)
Value
- array of user interface URIs.int GetCardSubmitType()
PT_WEBSERVICE_CARDSUBMIT_TYPES
.void SetCardSubmitType(int Value)
Value
- see PT_WEBSERVICE_CARDSUBMIT_TYPES
.java.lang.String GetProviderCLSID()
void SetProviderCLSID(java.lang.String Value)
Value
- CLSID of the provider.int GetSupportsPersonalization()
PT_GADGETPERSONALIZATION_ROLES
.void SetSupportsPersonalization(int Value)
Value
- bitmasked int of PT_GADGETPERSONALIZATION_ROLES
.void SetupHTTPRequest(java.lang.Object pHttpRequestParallel, IPTSSOInfo pSSOInfo)
pHttpRequestParallel
- the request object.pSSOInfo
- optional, can be null, but required for per-user basic auth.java.lang.String GetAbsoluteURL(java.lang.String bstrSettingName)
bstrSettingName
- the name of the relative URL in ProviderInfo.
boolean GetSupportsUserInterface(java.lang.String bstrUserInterfaceName)
bstrUserInterfaceName
- the URI of a user interface.
java.lang.Object CreateHTTPRequest(java.lang.Object pHttpSession, java.lang.Object pURL)
pHttpSession
- HTTPSessionpURL
- URL for the request
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |