com.plumtree.server
Interface IPTWebService

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTWebService
extends IPTObject

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.

Author:
JosephS
See Also:
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

GetEnabled

boolean GetEnabled()
Get the status of the web service, enabled or disabled. You should set a web service to disabled before taking it offline for routine maintainence or upgrades.

Returns:
True if enabled.

SetEnabled

void SetEnabled(boolean Value)
Set the status of the web service, enabled or disabled. You should set a web service to disabled before taking it offline for routine maintainence or upgrades.

Parameters:
Value - true if enabled.

GetDisabledMessage

java.lang.String GetDisabledMessage()
Get the message to show when the web service has been disabled.

Returns:
The message.

SetDisabledMessage

void SetDisabledMessage(java.lang.String Value)
Set the message to show when the web service has been disabled.

Parameters:
Value - the message.

GetProviderInfo

com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
Get additional provider-specific settings.

Returns:
The format varies by provider.

SetProviderInfo

void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Set additional provider-specific settings.

Parameters:
Value - the format varies by provider.

SetProviderInfo

void SetProviderInfo(java.lang.String Value)
Set additional provider-specific settings.

Parameters:
Value - a property bag serialized to XML.

GetRemoteServerID

int GetRemoteServerID()
Get the remote server associated with this web service. OPTIONAL: ID 0 indicates that no remote server is associated with this web service

Returns:
The ID of a remote server object.

SetRemoteServerID

void SetRemoteServerID(int Value)
Set the remote server associated with this web service. OPTIONAL: ID 0 indicates that no remote server is associated with this web service

Parameters:
Value - the ID of a remote server object.

GetUserInterfaces

java.lang.Object[] GetUserInterfaces()
Gets the UserInterfaces a web service supports.

Returns:
Array of user interface URIs.

SetUserInterfaces

void SetUserInterfaces(java.lang.String[] Value)
Sets the UserInterfaces a web service supports.

Parameters:
Value - array of user interface URIs.

SetUserInterfaces

void SetUserInterfaces(java.lang.Object[] Value)
Deprecated. 

Sets the UserInterfaces a web service supports.

Parameters:
Value - array of user interface URIs.

GetCardSubmitType

int GetCardSubmitType()
Gets the type of CardSubmission a web service supports.

Returns:
See PT_WEBSERVICE_CARDSUBMIT_TYPES.

SetCardSubmitType

void SetCardSubmitType(int Value)
Sets the type of CardSubmission a web service supports.

Parameters:
Value - see PT_WEBSERVICE_CARDSUBMIT_TYPES.

GetProviderCLSID

java.lang.String GetProviderCLSID()
Needed by Web Service Editor to support Web Service types.

Returns:
CLSID of the provider.

SetProviderCLSID

void SetProviderCLSID(java.lang.String Value)
Needed by Web Service Editor to support Web Service types.

Parameters:
Value - CLSID of the provider.

GetSupportsPersonalization

int GetSupportsPersonalization()
Flag set by the web service creator that indicates whether or not this web service allows personalization.

Returns:
Bitmasked int of PT_GADGETPERSONALIZATION_ROLES.

SetSupportsPersonalization

void SetSupportsPersonalization(int Value)
Flag set by the web service creator that indicates whether or not this web service allows personalization.

Parameters:
Value - bitmasked int of PT_GADGETPERSONALIZATION_ROLES.

SetupHTTPRequest

void SetupHTTPRequest(java.lang.Object pHttpRequestParallel,
                      IPTSSOInfo pSSOInfo)
Sets the basic auth headers on an IPTHttpRequestParallel.

Parameters:
pHttpRequestParallel - the request object.
pSSOInfo - optional, can be null, but required for per-user basic auth.

GetAbsoluteURL

java.lang.String GetAbsoluteURL(java.lang.String bstrSettingName)
Constructs an absolute URL relative to the remote server base URL from a ProviderInfo setting.

Parameters:
bstrSettingName - the name of the relative URL in ProviderInfo.
Returns:
The URL.

GetSupportsUserInterface

boolean GetSupportsUserInterface(java.lang.String bstrUserInterfaceName)
Indicates whether this web service supports a particular user interface.

Parameters:
bstrUserInterfaceName - the URI of a user interface.
Returns:
True if this user interface is supported.

CreateHTTPRequest

java.lang.Object CreateHTTPRequest(java.lang.Object pHttpSession,
                                   java.lang.Object pURL)
Creates IOKHttpRequest based on IOKHttpSession, IOKUrl, and http tracing parameters.

Parameters:
pHttpSession - HTTPSession
pURL - URL for the request
Returns:
IOKHttpRequest


Copyright 2008 Plumtree Software Inc. All Rights Reserved.