sync.master

Available methods

Description

Contains methods to set up information about known-"masters", for use on the "slave" side of ISS

Namespace:

sync.master

Method: addToMaster

HTTP POST

Description:

Add a single organizations to the list of those the specified Master has exported to this Slave

Parameters:

  • string sessionKey

  • int masterId - Id of the desired Master

  • struct orgMap

    • int "masterOrgId"

    • string "masterOrgName"

    • int "localOrgId"

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: create

HTTP POST

Description:

Create a new Master, known to this Slave.

Parameters:

  • string sessionKey

  • string label - Master’s fully-qualified domain name

Returns:

  • * struct IssMaster info

    • int "id"

    • string "label"

    • string "caCert"

    • boolean "isCurrentMaster"

Method: delete

HTTP POST

Description:

Remove the specified Master

Parameters:

  • string sessionKey

  • int masterId - Id of the Master to remove

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getDefaultMaster

HTTP GET

Description:

Return the current default-Master for this Slave

Parameters:

  • string sessionKey

Returns:

  • * struct IssMaster info

    • int "id"

    • string "label"

    • string "caCert"

    • boolean "isCurrentMaster"

Method: getMaster

HTTP GET

Description:

Find a Master by specifying its ID

Parameters:

  • string sessionKey

  • int masterId - ID of the desired Master

Returns:

  • * struct IssMaster info

    • int "id"

    • string "label"

    • string "caCert"

    • boolean "isCurrentMaster"

Method: getMasterByLabel

HTTP GET

Description:

Find a Master by specifying its label

Parameters:

  • string sessionKey

  • string label - Label of the desired Master

Returns:

  • * struct IssMaster info

    • int "id"

    • string "label"

    • string "caCert"

    • boolean "isCurrentMaster"

Method: getMasterOrgs

HTTP GET

Description:

List all organizations the specified Master has exported to this Slave

Parameters:

  • string sessionKey

  • int masterId - ID of the desired Master

Returns:

  • array :

  • struct IssMasterOrg info

    • int "masterOrgId"

    • string "masterOrgName"

    • int "localOrgId"

Method: getMasters

HTTP GET

Description:

Get all the Masters this Slave knows about

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct IssMaster info

    • int "id"

    • string "label"

    • string "caCert"

    • boolean "isCurrentMaster"

Method: hasMaster

HTTP POST

Description:

Check if this host is reading configuration from an ISS master.

Parameters:

Returns:

  • boolean master - True if has an ISS master, false otherwise

Method: makeDefault

HTTP POST

Description:

Make the specified Master the default for this Slave’s inter-server-sync

Parameters:

  • string sessionKey

  • int masterId - Id of the Master to make the default

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: mapToLocal

HTTP POST

Description:

Add a single organizations to the list of those the specified Master has exported to this Slave

Parameters:

  • string sessionKey

  • int masterId - ID of the desired Master

  • int masterOrgId - ID of the desired Master

  • int localOrgId - ID of the desired Master

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setCaCert

HTTP POST

Description:

Set the CA-CERT filename for specified Master on this Slave

Parameters:

  • string sessionKey

  • int masterId - ID of the Master to affect

  • string caCertFilename - path to specified Master’s CA cert

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setMasterOrgs

HTTP POST

Description:

Reset all organizations the specified Master has exported to this Slave

Parameters:

  • string sessionKey

  • int masterId - Id of the desired Master

  • array orgMaps

    • struct master-org details

      • int "masterOrgId"

      • string "masterOrgName"

      • int "localOrgId"

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: unsetDefaultMaster

HTTP POST

Description:

Make this slave have no default Master for inter-server-sync

Parameters:

  • string sessionKey

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: update

HTTP POST

Description:

Updates the label of the specified Master

Parameters:

  • string sessionKey

  • int masterId - ID of the Master to update

  • string label - Desired new label

Returns:

  • * struct IssMaster info

    • int "id"

    • string "label"

    • string "caCert"

    • boolean "isCurrentMaster"