Plumtree EDK (Enterprise Web Development Kit) 5.4.0

Plumtree.Remote Namespace

Provides an EDK Version class and common exception classes used by multiple services.

Namespace hierarchy

Classes

Class Description
AccessDeniedException Thrown when the user does not have access to the requested resource. Returned to the portal not as a SOAP Fault, but as a Status Code. The resource is not removed from the portal when this exception is thrown.
AccountExpiredException Throw this exception from IAuthProvider.Authenticate to tell the portal that the user's account has expired. Returned to the portal not as a SoapFault, but as a String containing a status code.
AccountLockedException Throw this exception from IAuthProvider.Authenticate to tell the portal that the user's account has been locked or disabled. Returned to the portal not as a SoapFault, but as a String containing a status code.
CustomAuthenticationFailureException Throw this exception from IAuthProvider.authenticate to tell the portal that there was a custom authentication failure. Returned to the portal not as a SoapFault, but as a String containing the message provided in the constructor.
CustomServiceFailureException Throw this exception from IAuthProvider.authenticate to tell the portal that there was a custom service failure. Returned to the portal not as a SoapFault, but as a String containing the message provided in the constructor.
GeneralFailureException Throw this exception from IAuthProvider.Authenticate to tell the portal that there was a general failure when attempting to authenticate the user. Returned to the portal not as a SoapFault, but as a String containing a status code.
InvalidConfigurationException Throw this exception from IAuthProvider.Authenticate to tell the portal that the Remote Server configuration is invalid. Returned to the portal not as a SoapFault, but as a String containing a status code.
InvalidUsernameOrPasswordException Throw this exception from IAuthProvider.Authenticate to tell the portal that the user has entered and invalid username or password. Returned to the portal not as a SoapFault, but as a String containing a status code.
NoLongerExistsException Throw this exception from a Crawler Web Service implementation of Plumtree.Remote.Crawler.IContainerProvider.AttachToContainer or Plumtree.Remote.Crawler.IDocumentProvider.AttachToDocument when the requested resource no longer exists. Returned to the portal not as a SOAP Fault, but as a Status Code. The resource is removed from the portal when this exception is thrown.
NoSuchUserException Thrown when the requested user does not exist. Returned to the portal not as a SOAP Fault, but as a Status Code.
NotAvailableException Thrown when the referenced object is no longer available. Returned to the portal not as a SOAP Fault, but as a Status Code. The resource is not removed from the portal when this exception is thrown.
NotInitializedException Thrown when the referenced object has not been initialized. Returned to the portal not as a SOAP Fault, but as a Status Code
PasswordExpiredException Throw this exception from IAuthProvider.Authenticate to tell the portal that the user's password has expired and must be changed Returned to the portal not as a SoapFault, but as a String containing a status code.
PasswordMustChangeException Throw this exception from IAuthProvider.Authenticate to tell the portal that the user's password must change. Returned to the portal not as a SoapFault, but as a String containing a status code.
RemoteServerUnavailableException Throw this exception from IAuthProvider.Authenticate to tell the portal that the Remote Server is unavailable. Returned to the portal not as a SoapFault, but as a String containing a status code.
RemoteServerUnreachableException Throw this exception from IAuthProvider.Authenticate to tell the portal that the Remote Server is unreachable. Returned to the portal not as a SoapFault, but as a String containing a status code.
ServiceException Base class for exceptions. ServiceExceptions are returned to the Portal as SOAP Faults, except in the cases of subclasses that return a status code. These subclasses include: AccessDeniedException NoLongerExistsException NoSuchUserException NotInitializedException and ValidationException
Version Provides information about the EDK build version, such as the major version number and the minor version number of the build. The printable string includes additional information, such as the source changelist number and the date of the build.