R: Class '"WSSEAuth"'

WSSEAuth-class {SSOAP} | R Documentation

## Class `"WSSEAuth"`

### Description

This is a class that is used to represent authentication information that is to be sent as part of the SOAP request. It is made up of a username and password. The object can then be converted to the appropriate XML.

### Objects from the Class

Objects can be created by calls of the form `new("WSSEAuth", ...)`.

### Slots

`username`:

  Object of class `"character"` the user name/login to identify the person making the request

`password`:

  Object of class `"character"` the password for that user

`required`:

  Object of class `"logical"` an optional value that indicates whether to add the mustUnderstand attribute in the request to ensure that the server raises an error if the authentication is not understood or fails.

### Methods

coerce

  `signature(from = "WSSEAuth", to = "XMLInternalElementNode")`: ...

coerce

  `signature(from = "WSSEAuth", to = "XMLInternalNode")`: ...

### Author(s)

Duncan Temple Lang

### References

http://en.wikipedia.org/wiki/WS-Security http://msdn.microsoft.com/en-us/library/ms951257.

### See Also

`.SOAP`

### Examples

    showClass("WSSEAuth")

    auth = new("WSSEAuth", username = "duncan", password = "bob")
    as(auth, "XMLInternalNode")

    ## Not run:
      # This adds a Header to the request with user name and password
      # It is NOT needed for this service, but we are just using it as an
      # example of how we can pass the authentication information.
    .SOAP("http://soap.genome.jp/keggapi/request_v6.2.cgi", "list_databases",
           action = "SOAP/KEGG#list_databases",
           .soapHeader = auth)

    ## End(Not run)

[Package SSOAP version 0.91-0 Index]