Namespace: AuthProxy

Classes

CertificateFromFile

CertificateFromLogonManager

CertificateFromStore

Members

(constant) ERR_CERTIFICATE_ALIAS_NOT_FOUND :number

Type:

• number

(constant) ERR_CERTIFICATE_FILE_NOT_EXIST :number

Type:

• number

(constant) ERR_CERTIFICATE_INVALID_FILE_FORMAT :number

Type:

• number

(constant) ERR_CLIENT_CERTIFICATE_VALIDATION :number

Type:

• number

(constant) ERR_DOMAIN_WHITELIST_REJECTION :number

Type:

• number

(constant) ERR_FILE_CERTIFICATE_SOURCE_UNSUPPORTED :number

Type:

• number

(constant) ERR_GET_CERTIFICATE_FAILED :number

Type:

• number

(constant) ERR_HTTP_TIMEOUT :number

Type:

• number

(constant) ERR_INVALID_PARAMETER_VALUE :number

Type:

• number

(constant) ERR_LOGON_MANAGER_CERTIFICATE_METHOD_NOT_AVAILABLE :number

Type:

• number

(constant) ERR_LOGON_MANAGER_CORE_NOT_AVAILABLE :number

Type:

• number

(constant) ERR_MISSING_PARAMETER :number

Type:

• number

(constant) ERR_NO_SUCH_ACTION :number

Type:

• number

(constant) ERR_SERVER_CERTIFICATE_VALIDATION :number

Type:

• number

(constant) ERR_SERVER_REQUEST_FAILED :number

Type:

• number

(constant) ERR_SYSTEM_CERTIFICATE_SOURCE_UNSUPPORTED :number

Type:

• number

(constant) ERR_UNKNOWN :number

Type:

• number

Methods

addHTTPSConversionHost(successCB, errorCB, url)

Parameters:

Example

var successCB = function(){
    alert("HTTPS conversion host successfully added.");
}
var errorCB = function(error){
    alert("error adding HTTPS conversion host: " + JSON.stringify(error));
}
sap.AuthProxy.addHTTPSConversionHost(successCB, errorCB, "https://someHost.com");

clearClientCertPreferences(successCallback, errorCallback)

Parameters:

deleteCertificateFromStore(successCB, errorCBopt, certificateKey)

Parameters:

Example

var successCB = function(){
    alert("certificate successfully deleted.");
}
var errorCB = function(error){
    alert("error deleting certificate: " + JSON.stringify(error));
}
sap.AuthProxy.deleteCertificateFromStore(successCB, errorCB, "certificateKeyToDelete");

generateODataHttpClient()

Example

OData.defaultHttpClient = sap.AuthProxy.generateODataHttpClient();

// Using a certificate from file, for example.
fileCert = new sap.AuthProxy.CertificateFromFile("mnt/sdcard/cert.p12", "password", "certKey");

// This is the same request object you would have created if you were just using Datajs, but now
// you can add the extra 'certificateSource' property.
var createRequest = {
    requestUri: "http://www.example.com/stuff/etc/example.svc",
    certificateSource : fileCert,
    user : "username",
    password : "password",
    method : "POST",
    data:
    {
         Description: "Created Record",
         CategoryName: "Created Category"
    }
}

// Use Datajs to send the request.
OData.request( createRequest, successCallback, failureCallback );

generateODataHttpClient2()

Example

OData.defaultHttpClient = sap.AuthProxy.generateODataHttpClient2();

The below sample use a certificate from file, and a preset user and password.
var request = {
                  authConfig : {basic:
                                  [
                                     {type:"preset", data:{user:"smptester", password:"SMP_t3st3r"}}
                                  ],
                                clientCert:
                                  [
                                      {type: "file", data: { path:"cert.p12", password:"password$", certificateKey:"client"}}
                                  ]
                                },
                  requestUri : "http://www.example.com/stuff/etc/example.svc",
                  method : "GET"
  };
  odatajs.oData.request(request, successCallback, errorCallback, null, httpClient);
The below sample use a certificate from file, and allow user to input credential at runtime.
var request = {
                  authConfig : {basic:
                                  [
                                      {type:"user"}
                                  ],
                                clientCert:
                                  [
                                      {type: "file", data: { path:"cert.p12", password:"password$", certificateKey:"client"}}
                                  ]
                                },
                  requestUri : "http://www.example.com/stuff/etc/example.svc",
                  method : "GET"
  };
  odatajs.oData.request(request, successCallback, errorCallback, null, httpClient);

get(url, header, successCB, errorCB, useropt, passwordopt, timeoutopt, certSourceopt) → {function}

Parameters:

Returns:

Type

function

Example

var successCB = function(serverResponse){
    alert("Status: " + JSON.stringify(serverResponse.status));
    alert("Headers: " + JSON.stringify(serverResponse.headers));
    if (serverResponse.responseText){
        alert("Response: " + JSON.stringify(serverResponse.responseText));
    }
}
var errorCB = function(errorObject){
    alert("Error making request: " + JSON.stringify(errorObject));
}

// To send a GET request to server, call the method
var abortFunction = sap.AuthProxy.get("http://www.example.com", null, successCB, errorCB);

// An example of aborting the request
abortFunction();

// To send a GET request to the server with headers, call the method
sap.AuthProxy.get("http://www.example.com", {HeaderName : "Header value"}, successCB, errorCB);

// To send a GET request to the server with basic authentication, call the method
sap.AuthProxy.get("https://www.example.com", headers, successCB, errorCB, "username", "password");

// To send a GET request to the server with mutual authentication, call the method
sap.AuthProxy.get("https://www.example.com", headers, successCB, errorCB, null, null, 0, 
    new sap.AuthProxy.CertificateFromLogonManager("theAppId"));

sendRequest(method, url, header, requestBody, successCB, errorCB, useropt, passwordopt, timeoutopt, certSourceopt) → {function}

Parameters:

Returns:

Type

function

Example

// callbacks
var successCB = function(serverResponse){
    alert("Status: " + JSON.stringify(serverResponse.status));
    alert("Headers: " + JSON.stringify(serverResponse.headers));
    alert("Response: " + JSON.stringify(serverResponse.response));
}
var errorCB = function(errorObject){
    alert("Error making request: " + JSON.stringify(errorObject));
}

// To send a post request to the server, call the method
var abortFunction = sap.AuthProxy.sendRequest("POST", "http://www.google.com", null, "THIS IS THE BODY", successCB, errorCB);
// An example of aborting the request
abortFunction();

// To send a post request to the server with headers, call the method
sap.AuthProxy.sendRequest("POST", url, {HeaderName : "Header value"}, "THIS IS THE BODY", successCB, errorCB);

// To send a post request to the server with basic authentication, call the method
sap.AuthProxy.sendRequest("POST", url, headers, "THIS IS THE BODY", successCB, errorCB, "username", "password");

// To send a post request to the server with mutual authentication, call the method
sap.AuthProxy.sendRequest("POST", "https://hostname", headers, "THIS IS THE BODY", successCB, errorCB, null, 
    null, 0, new sap.AuthProxy.CertificateFromLogonManager("theAppId"));

sendRequest2(method, url, header, requestBody, successCB, errorCB, timeoutopt, authConfigopt, forCheckReachabilityopt) → {function}

Parameters:

Returns:

Type

function

Example

// callbacks
var successCB = function(serverResponse){
    alert("Status: " + JSON.stringify(serverResponse.status));
    alert("Headers: " + JSON.stringify(serverResponse.headers));
    alert("Response: " + JSON.stringify(serverResponse.response));
}
var errorCB = function(errorObject){
    alert("Error making request: " + JSON.stringify(errorObject));
}

// To send a post request to the server, call the method
var abortFunction = sap.AuthProxy.sendRequest("POST", "http://www.google.com", null, "THIS IS THE BODY", successCB, errorCB);
// An example of aborting the request
abortFunction();

// To send a post request to the server with headers, call the method
sap.AuthProxy.sendRequest("POST", url, {HeaderName : "Header value"}, "THIS IS THE BODY", successCB, errorCB);

// To send a post request to the server with preset basic authentication configuration, call the method
var authConfig = {basic:[{type:"preset", data:{user:"myname", password:"mypassword"}}, {type:"user"}]};
sap.AuthProxy.sendRequest("POST", url, headers, "THIS IS THE BODY", successCB, errorCB, null, authConfig);

// To send a post request to the server with mutual authentication selected by user, call the method
var authConfig = {clientcert:[{type:"user"}]};
sap.AuthProxy.sendRequest("POST", "https://hostname", null, "THIS IS THE BODY", successCB, errorCB, null, authConfig);

setAutoSelectCertificateConfig(successCB, errorCBopt, autoSelectSingleCert)

Parameters:

Example

var successCB = function(){
    console.log("setAutoSelectCertificateConfig called successfully.");
}
var errorCB = function(error){
    console.log("error calling setAutoSelectCertificateConfig: " + JSON.stringify(error));
}
sap.AuthProxy.setAutoSelectCertificateConfig(successCB, errorCB, enableAutoSelectSingleCert);

Type Definitions

deleteCertificateSuccessCallback()

errorCallback(errorObject)

Parameters:

Example

function errorCallback(errCode) {
   //Set the default error message. Used if an invalid code is passed to the
   //function (just in case) but also to cover the
   //sap.AuthProxy.ERR_UNKNOWN case as well.
   var msg = "Unkown Error";
   switch (errCode) {
      case sap.AuthProxy.ERR_INVALID_PARAMETER_VALUE:
         msg = "Invalid parameter passed to method";
         break;
      case sap.AuthProxy.ERR_MISSING_PARAMETER:
         msg = "A required parameter was missing";
         break;
      case sap.AuthProxy.ERR_HTTP_TIMEOUT:
         msg = "The request timed out";
         break;
   };
   //Write the error to the log
   console.error(msg);
   //Let the user know what happened
   navigator.notification.alert(msg, null, "AuthProxy Error", "OK");
};

successCallback(serverResponse)

Parameters: