Stop server

Operation Name

Stop server

Function overview

Terminates specified server.

Data Model

XML type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.

Required settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Destination	Required	Not available	Select global resource. [Add]: Add new global resource. [Edit list]: Global resource settings can be edited with "Edit Resource list".
Server List	Required	Available	Specify the IDs of the servers to be terminated. Each column can be operated with the following buttons. [Add]: Add an server [Up]: Move the order of the selected server upwards by one. [Down]: Move the order of the selected server downwards by one. [Delete]: Delete the server.
Server List/Server ID (Name)	Required	Available	Specify ID of the server to be terminated.	There is no choice item when initial display. When pushing [Get server name list],the server name which is created in [Distination] appears.
Stand by until server terminates	Required	Available	Select whether to wait until the server stops. [Checked]: (default) process is put on hold until the server is terminated. [Not Checked]: Proceeds with its subsequent operation without waiting for the termination of the server.	If it is [Checked], the state of the server in the process of being launched is monitored until it times out, determined by the value specified in the [Timeout] defined for the [Connect To] of the Global Resource specified. Proceeds with its subsequent operation when the termination of the server is confirmed. Error will be raised, if the termination of the server could not be confirmed within the millisecond value allotted in the [Timeout].

Property Action<

Item name	Description	Remarks
Get server name list	Enables to select from [server name list/server name] by acquiring server name created in [Destination].

Comment

Item name	Required/Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

<?xml version="1.0"?>
<servers>
  <server currentStatus="" name="" previousStatus="" />
</servers>

Element Name	Attribute Name	Description
servers	-
server	-	Appears in each server specified in [server name list/server name].
	currentStatus	Returns current server status. [running]: server is launched. [pending]: server is in the process of being launched. [stopped]: server is stopped.
	name	Output server ID (name).
	previousStatus	Output the status of server just before current. [running]: server is launched. [pending]: server is in the process of being launched. [stopped]: server is stopped.

Loading Schema on Mapper

Schema is loaded automatically.

For more details, refer to "Edit schema".

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available component variables

Component variable name	Description	Remarks
message_category	Stores the category to which corresponding message code belongs to of occured error.	The value defaults to null.
message_code	Stores its corresponding message code of the occured error.	The value defaults to null.
message_level	Stores the severity of the corresponding message code of the occured error.	The value defaults to null.
error_type	Stores the type of the occured error.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on DataSpider Servista version.
error_message	Stores the error message for the occured error.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	Stores the stack trace of the occured error.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

If one of the server has failed to stop and triggered an error, then none of the other running servers will be requested to stop.

Main exceptions

Exception name	Cause	Solution
ResourceNotFoundException Resource definition could not be found.Name: []	[Destination] is not specified.	Specify[Destination].
ResourceNotFoundException Resource definition could not be found.Name: [<name of global resource>]	Resource definition selected in [Destination] is not found.	Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property Name> is not specified.	[<Property Name>] is not specified.	Please specify [<Property Name>].
InvalidPropertyConfigurationException Timeout must be bigger than 0.	Number less than 0 is put in [Timeout] of global resource specified in [Destination].	Enter the number bigger than 0 at [Timeout] specified in [Destination].
InvalidPropertyConfigurationException Input an integer or a variable in Timeout.	Value which is not a numerical value is put in [Timeout] of global resource specified in [Destination].	Put a numerical value in [Timeout] of global resource specified in [Destination].
NiftyCloudOperationTimeoutException The status of the server was not updated within the allotted millisecond in <Timeout>	server has failed to terminate within the timeout period allotted by the [Destination] [Timeout].	confirm the specified timeout value in the [Timeout] within the [Destination].
com.nifty.cloud.sdk.NiftyServiceException Client.InvalidserverID.NotFound: The server ID '<server name>' does not exist.	There is no server entered in [server name list/server name]	Enter a right server name in [server name list/server name].
com.nifty.cloud.sdk.NiftyServiceException Client.AuthFailure: This system was not able to validate the provided access key.	A value of [AccessKey] of global resource specified in [Destination] or [SecretAccessKey]is wrong.	Enter a right value in [AccessKey], [SecretAccessKey] of global resource specified in [Destination].
com.nifty.cloud.sdk.NiftyServiceException org.apache.commons.httpclient.ConnectTimeoutException: The host did not accept the connection within timeout of <Timeout> ms	Timeout has occurred in the process of conneting with the host.	Confirm network condition or [Timeout] of global resource specified in [Destination].
com.nifty.cloud.sdk.NiftyServiceException java.net.SocketTimeoutException: Read timed out	Timeout has occurred after it connects to host and before host responces.	Confirm the host condition or [Timeout] of global resource specified in [Destination].

Notes

HTTPS is used in the communication between Niftycloud and this adapter.

Executes "Normal Stop".

Execute stop processings for only the server with status "running".

When "NiftyCloudOperationTimeoutException" occurs, server stop demand is completed. Server start processing is executed even though executing error occurs.

For more detail about trouble and maintenance information of Niftycloud, refer to "Niftycloud Information"(http://info.biz.nifty.com/cloud/).