com.plumtree.server
Interface IPTGadgetContentServer

All Superinterfaces:

IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTGadgetContentServer
extends IPTObject

This interface wraps access to a specific remote server instance. A remote server is an object that stores connection information shared by multiple web service objects.

Author:

JosephS

See Also:

IPTWebService

Method Summary

java.lang.String	GetEncryptedPassword() Get the encrypted password for HTTP basic authentication.
java.lang.String	GetLogin() Get the login for HTTP basic authentication.
java.lang.String	GetPublicKey() The public key can be used to encrypt data before sending it to the remote server.
boolean	GetSendUserBasicAuthentication() Should web services use the current user's login and password or a common login and password set by the administrator when accessing this web server?
java.lang.String	GetURL() Get the base URL for the remote server.
void	SetLogin(java.lang.String Value) Set the login for HTTP basic authentication.
void	SetPassword(java.lang.String Value) Set the password for HTTP basic authentication.
void	SetPublicKey(java.lang.String strPublicKey) The public key can be used to encrypt data before sending it to the remote server.
void	SetSendUserBasicAuthentication(boolean Value) Should web services use the current user's login and password or a common login and password set by the administrator when accessing this web server?
void	SetURL(java.lang.String Value) Set the base URL for the remote server.

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

GetURL

java.lang.String GetURL()

Get the base URL for the remote server. URLs will be stored in the web service objects relative to this base URL.

Returns:

The base URL.

SetURL

void SetURL(java.lang.String Value)

Set the base URL for the remote server. URLs will be stored in the web service objects relative to this base URL.

Parameters:

Value - the base URL.

GetLogin

java.lang.String GetLogin()

Get the login for HTTP basic authentication.

Returns:

The login.

SetLogin

void SetLogin(java.lang.String Value)

Set the login for HTTP basic authentication.

Parameters:

Value - the login.

GetEncryptedPassword

java.lang.String GetEncryptedPassword()

Get the encrypted password for HTTP basic authentication. For server internal use, there is no supported method to decrypt this password in the public interface.

Returns:

The encrypted password.

SetPassword

void SetPassword(java.lang.String Value)

Set the password for HTTP basic authentication.

Parameters:

Value - the plain-text password.

SetSendUserBasicAuthentication

void SetSendUserBasicAuthentication(boolean Value)

Should web services use the current user's login and password or a common login and password set by the administrator when accessing this web server?

Parameters:

Value - true=send user login, false=send admin login or none

GetSendUserBasicAuthentication

boolean GetSendUserBasicAuthentication()

Should web services use the current user's login and password or a common login and password set by the administrator when accessing this web server?

Returns:

true=send user login, false=send admin login or none

GetPublicKey

java.lang.String GetPublicKey()

The public key can be used to encrypt data before sending it to the remote server. It can then be sent across an insecure channel, because only the owner of the corresponding private key can decrypt it.

Returns:

the public key

SetPublicKey

void SetPublicKey(java.lang.String strPublicKey)

The public key can be used to encrypt data before sending it to the remote server. It can then be sent across an insecure channel, because only the owner of the corresponding private key can decrypt it.

Parameters:

strPublicKey - the public key