Java Upgrade Schedule object

The Java Upgrade Schedule objectcreates and manages a schedule to upgrade a runtime, Runtime cluster, Runtime cloud, or API Gateway to the latest version of Java, provides information about an existing schedule, and deletes an existing schedule.

Structure

note

You can set one schedule only for a specified runtime, Runtime cluster, Runtime cloud, or API Gateway.

<JavaUpgradeSchedule
   atomId=""
   scheduleType=""
   hourOfDay=""
   timeZone=""
   dayOfWeek="" >
   <JavaUpgradeOptions>
      <cacertsPath="certPath"/>
      <externalJDKPath="extPath"/>
      <prefJreLocation=""/>
   </JavaUpgradeOptions>
</JavaUpgradeSchedule>

Field	Type	Description
Filter	Filter	Filter
atomId	string	The ID of the container for which you want to set schedule.
scheduleType	string	(Required) Determines when you receive the Java upgrades: Immediately when they are available or in the first or second (last) week they are available prior to the . 1. FIRST - Upgrade within the first week that Java upgrades are available. 2. LAST - Upgrade within the second week that Java upgrades are available 3. IMMEDIATE - Upgrade immediately after Java upgrades are available 4. NEVER - The schedule does not upgrade the Java version of the specified container Note: If scheduleType is set to NEVER, you can still use other upgrade options, such as the Upgrade Java operation or the Boomi Enterprise Platform.
hourOfDay	integer	The hour of the day that you want to receive Java upgrades on the runtime, Runtime cluster, Runtime cloud, or API Gateway. 1. Must be between 0-23. 2. Required if scheduleType is set to FIRST or LAST
dayOfWeek	string	The day of the week that you want to receive Java upgrades on the runtime, Runtime cluster, Runtime cloud, or API Gateway.- Required if scheduleType is set to FIRST or LAST
timeZone	string	The time zone of your set schedule.- Must be a valid time zone 1. Required if scheduleType is set to FIRST or LAST
JavaUpgradeOptions	string	(Optional) Represents any options a user can specify as part of running the upgrade script manually. The following attributes are available as options and are detailed elsewhere in this table: - cacertsPath - prefJreLocation - externalJDKPath If you omit JavaUpgradeOptions from your request, the attributes assume the default value.
cacertsPath	string	(Optional) If specified, defines the directory file path from which to migrate custom certificates.If you include this attribute in your request, the directory file path in your local drive must contain either of the following folder patterns: jre/lib/security/cacerts or lib/security/cacerts, where cacerts is the name of the certificate file. Note: The certificate file must be titled cacerts. Because the JavaUpgradeSchedule API object automatically appends the lib/security and jre/lib/security part of the file path to search for the cacerts file name, you need only supply the root directory or the root directory and JRE folder in the value of your request. For example, if your certificates file is located at /boomi_atom/jre/lib/security/cacerts, you need to specify either /boomi_atom/jre or /boomi_atom in the attribute's value. If you omit this attribute from the request or its value does not populate, it uses the default JVM directory.
prefJreLocation	string	Determines how to update the installation's JRE or whether to use an external JDK. The following values are possible:- INTERNAL - Switch the preferred JRE to the installation's JRE directory - CURRENT - Do not make changes to the preferred JRE - EXTERNAL - Use external JDK for preferred JRE If you do not specify a value or eliminate the attribute, the default value is CURRENT.
externalJDKPath	string	Required if prefJreLocation is set to EXTERNAL.Defines the directory file path in which to find the custom JDK that your container uses after upgrading. Include this attribute in the request when you want to use a custom JDK rather than one provided by . If you do not specify this attribute, the upgrade file automatically installs a new -provided JRE to your local directory with the latest supported version of Java.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Supported	Not Supported	Supported	Supported	Not Supported	Supported

Notes:

The GET operation returns the current schedule for receiving Java upgrades on a specified runtime, Runtime cluster, Runtime cloud, or API Gateway.
The CREATE operation sets a schedule for receiving Java upgrades with the scheduleType, dayOfWeek, hourOfDay, timeZone, JavaUpgradeOptions, cacertsPath, prefJreLocation, and externalJDKPath fields.
The UPDATE operation modifies a set schedule for receiving Java upgrades.
The DELETE operation sets the scheduleType to NEVER, turning off the Auto-update feature in the and deleting the schedule record from the database. You can still use other upgrade options, such as the Upgrade Java operation or the Java upgrade tool in the .

RESTishimplementation

GET operation

Send an HTTP GET request to https://api.boomi.com/api/rest/v1/<accountId>/JavaUpgradeSchedule/<atomID>

where accountId is the authentication account for the request and atomId is the ID of the runtime, Runtime cluster, Runtime cloud, or API Gateway for retrieving the Java upgrade schedule.

XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:JavaUpgradeSchedule 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:bns="http://api.platform.boomi.com/" 
    atomId="01f3696e-6d92-4668-8019-061fec55264c" 
    scheduleType="FIRST" 
    dayOfWeek="MONDAY" 
    hourOfDay="15" 
    timeZone="America/New_York">
        <bns:JavaUpgradeOptions>
            <bns:migrateCertificate>true</bns:migrateCertificate>
            <bns:cacertsPath>/cacerts/path1,?bns:cacertsPath>
            <bns:externalJDKPath>/external/JDK/path1</bns:externalJDKPath>
            <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
        </bns:JavaUpgradeSchedule>

For a JSON response, send the request with the HTTP header :

Accept:application/json

JSON response:

{
"@type": "JavaUpgradeSchedule",
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "FIRST",
"dayOfWeek": "MONDAY",
"hourOfDay": "15",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
    "migrateCertificate": true,
    "cacertsPath": "/cacerts/path1",
    "externalJDKPath": "/external/JDK/path1",
    "prefJreLocation": "EXTERNAL"
    }
}

CREATE operation

Send an HTTP POST request to https://api.boomi.com/api/rest/v1/<accountId>/JavaUpgradeSchedule

where accountId is the ID of the authenticating account for the request.

XML request:

<bns:JavaUpgradeSchedule 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:bns="http://api.platform.boomi.com/" 
    atomId="01f3696e-6d92-4668-8019-061fec55264c" 
    scheduleType="FIRST" 
    hourOfDay="13" 
    timeZone="America/New_York" 
    dayOfWeek="TUESDAY">
    <bns:JavaUpgradeOptions>
        <bns:cacertsPath>/cacerts/path</bns:cacertsPath>
        <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
        <bns:externalJDKPath>/external/JDK/path</bns:externalJDKPath>
    </bns:JavaUpgradeOptions>
</bns:JavaUpgradeSchedule>

XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:JavaUpgradeSchedule 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:bns="http://api.platform.boomi.com/" 
    atomId="01f3696e-6d92-4668-8019-061fec55264c" 
    scheduleType="FIRST" 
    dayOfWeek="TUESDAY" 
    hourOfDay="13" 
    timeZone="America/New_York">
    <bns:JavaUpgradeOptions>
        <bns:migrateCertificate>true</bns:migrateCertificate>
        <bns:cacertsPath>/cacerts/path</bns:cacertsPath>
        <bns:externalJDKPath>/external/JDK/path</bns:externalJDKPath>
        <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
    </bns:JavaUpgradeOptions>
</bns:JavaUpgradeSchedule>

For a JSON request, send the request with the HTTP header:

Content-Type: application/json

JSON request:

{
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "FIRST",
"dayOfWeek": "TUESDAY",
"hourOfDay": "13",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
    "migrateCertificate": true,
    "cacertsPath": "/cacerts/path1",
    "externalJDKPath": "/external/JDK/path1",
    "prefJreLocation": "EXTERNAL"
    }
}

For a JSON response, send the request with the HTTP header:

Accept: application/json

JSON response:

{
"@type": "JavaUpgradeSchedule",
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "FIRST",
"dayOfWeek": "TUESDAY",
"hourOfDay": "13",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
    "migrateCertificate": true,
    "cacertsPath": "/cacerts/path1",
    "externalJDKPath": "/external/JDK/path1",
    "prefJreLocation": "EXTERNAL"
    }
}

UPDATE operation

Send an HTTP POST to https://api.boomi.com/api/rest/v1/<accountId>JavaUpgradeSchedule/<atomID>

where accountId is the authenticating account for the request and atomId is the ID of the runtime, Runtime cluster, Runtime cloud, or API Gateway for which you want to update a set schedule.

XML request:

<bns:JavaUpgradeSchedule 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:bns="http://api.platform.boomi.com/" 
    atomId="01f3696e-6d92-4668-8019-061fec55264c" 
    scheduleType="LAST" 
    hourOfDay="16" 
    timeZone="America/New_York" 
    dayOfWeek="MONDAY">
    <bns:JavaUpgradeOptions>
        <bns:cacertsPath>/cacerts/path</bns:cacertsPath>
        <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
        <bns:externalJDKPath>/external/JDK/path</bns:externalJDKPath>
    </bns:JavaUpgradeOptions>
</bns:JavaUpgradeSchedule>

XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:JavaUpgradeSchedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:bns="http://api.platform.boomi.com/" 
    atomId="01f3696e-6d92-4668-8019-061fec55264c" 
    scheduleType="LAST" 
    dayOfWeek="MONDAY" 
    hourOfDay="16" 
    timeZone="America/New_York">
    <bns:JavaUpgradeOptions>
        <bns:migrateCertificate>true</bns:migrateCertificate>
        <bns:cacertsPath>/cacerts/path</bns:cacertsPath>
        <bns:externalJDKPath>/external/JDK/path</bns:externalJDKPath>
        <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
    </bns:JavaUpgradeOptions>
</bns:JavaUpgradeSchedule>

For a JSON request, send the request with the HTTP header:

Content-Type: application/json

JSON request:

{
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "LAST",
"dayOfWeek": "MONDAY",
"hourOfDay": "16",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
    "migrateCertificate": true,
    "cacertsPath": "/cacerts/path1",
    "externalJDKPath": "/external/JDK/path1",
    "prefJreLocation": "EXTERNAL"
    }
}

For a JSON response, send the request with the HTTP header:

Accept: application/json

JSON response:

{
"@type": "JavaUpgradeSchedule",
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "LAST",
"dayOfWeek": "MONDAY",
"hourOfDay": "16",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
    "migrateCertificate": true,
    "cacertsPath": "/cacerts/path1",
    "externalJDKPath": "/external/JDK/path1",
    "prefJreLocation": "EXTERNAL"
    }
}

DELETE operation

Send an HTTP DELETE to https://api.boomi.com//api/rest/v1/<accountId>/JavaUpgradeSchedule/<atomId>

where accountId is the authenticating account for the request and atomId is the ID of the runtime, Runtime cluster, Runtime cloud, or API Gateway for which you want to delete a Java upgrade schedule.

If you deleted the schedule successfully, the response is <true\>.

For a JSON response, send the request with the HTTP header:

Accept: application/json.

If you deleted the schedule successfully, the response is \{true\}.

SOAP implementation

GET operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:get xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <api:objectType>JavaUpgradeSchedule</api:objectType>
         <api:objectId>ATOM_ID</api:objectId>
         </api:get>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
         <bns:result xsi:type="bns:JavaUpgradeSchedule" atomId="01f3696e-6d92-4668-8019-061fec55264d" scheduleType="LAST" dayOfWeek="MONDAY" hourOfDay="12" timeZone="Pacific/Pago_Pago">
            <bns:JavaUpgradeOptions>
               <bns:migrateCertificate>true</bns:migrateCertificate>
               <bns:cacertsPath>/cacerts/path</bns:cacertsPath>
              <bns:externalJDKPath>/external/JDK/path</bns:externalJDKPath>
              <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
            </bns:JavaUpgradeOptions>
         </bns:result>
      </bns:getResponse>
   </S:Body>
</S:Envelope>

CREATE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:create xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <object xsi:type="api:JavaUpgradeSchedule" atomId="01f3696e-6d92-4668-8019-061fec55264d" scheduleType="FIRST" hourOfDay="11" timeZone="America/New_York" dayOfWeek="TUESDAY">
            <api:JavaUpgradeOptions>
               <api:cacertsPath>/cacerts/path</api:cacertsPath>
               <api:prefJreLocation>EXTERNAL</api:prefJreLocation>
               <api:externalJDKPath>/external/JDK/path</api:externalJDKPath>
            </api:JavaUpgradeOptions>
         </object>
      </api:create>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
         <result xsi:type="bns:JavaUpgradeSchedule" atomId="01f3696e-6d92-4668-8019-061fec55264d" scheduleType="FIRST" dayOfWeek="TUESDAY" hourOfDay="11" timeZone="America/New_York">
            <bns:JavaUpgradeOptions>
               <bns:migrateCertificate>true</bns:migrateCertificate>
               <bns:cacertsPath>/cacerts/path</bns:cacertsPath>
               <bns:externalJDKPath>/external/JDK/path</bns:externalJDKPath>
               <bns:prefJreLocation>EXTERNAL</bns:prefJreLocation>
            </bns:JavaUpgradeOptions>
         </result>
      </bns:createResponse>
   </S:Body>
</S:Envelope>

UPDATE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:update xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <object xsi:type="api:JavaUpgradeSchedule" atomId="01f3696e-6d92-4668-8019-061fec55264d" scheduleType="LAST" hourOfDay="10" timeZone="Pacific/Pago_Pago" dayOfWeek="MONDAY">
            <api:JavaUpgradeOptions>
               <api:cacertsPath>/cacerts/path</api:cacertsPath>
               <api:prefJreLocation>INTERNAL</api:prefJreLocation>
            </api:JavaUpgradeOptions>
         </object>
      </api:update>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
         <result xsi:type="bns:JavaUpgradeSchedule" atomId="01f3696e-6d92-4668-8019-061fec55264d" scheduleType="LAST" dayOfWeek="MONDAY" hourOfDay="10" timeZone="Pacific/Pago_Pago">
            <bns:JavaUpgradeOptions>
               <bns:migrateCertificate>true</bns:migrateCertificate>
               <bns:cacertsPath>/cacerts/path</bns:cacertsPath>ATOMSPHERE_PASSWORD
               <bns:prefJreLocation>INTERNAL</bns:prefJreLocation>
            </bns:JavaUpgradeOptions>
         </result>
      </bns:updateResponse>
   </S:Body>
</S:Envelope>

DELETE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:delete>
         <!--Optional:-->
         <objectType>JavaUpgradeSchedule</objectType>
         <!--Optional:-->
         <objectId>e92acd9e-d658-46d0-af3d-ea869101607b</objectId>
         <!--Optional:-->
      </api:delete>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:deleteResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
         <successful>true</successful>
      </bns:deleteResponse>
   </S:Body>
</S:Envelope>

Structure​

Supported operations​

RESTishimplementation​

SOAP implementation​

Structure

Supported operations

RESTishimplementation

SOAP implementation