Web_service_response - Programmschnittstelle (API)

Web_service_response

	web_service_response.binary_content =	Nutzdaten als Byte-Array (nur Java)

String	web_service_response.charset_name	Zeichencodierung

String	web_service_response.content_type	Content-Type (ohne Parameter)

	web_service_response.header( name ) = value	Eintrag im Kopf
String	web_service_response.header( name )

	web_service_response.send()	Antwort senden

	web_service_response.status_code = Integer	HTTP-Status-Code

	web_service_response.string_content = text	Nutzdaten als Text

Die Eigenschaft binary_content steht nur unter Java zur Verfügung.

Siehe auch <web_service>

binary_content

Nutzdaten als Byte-Array (nur Java)

web_service_response.binary_content =

Beispiel in java

String               text         = "This is my response";
String               charset_name = "ISO-8859-1";
Web_service_response response     = spooler_task.order().web_service_operation().response();

response.set_header( "Content-Type", "text/plain; charset=" + charset_name );

ByteArrayOutputStream byos = new ByteArrayOutputStream();
Writer writer = new OutputStreamWriter( byos, charset_name );
writer.write( text );
writer.close();

response.set_binary_content( byos.toByteArray() );
response.send();

Die Eigenschaft steht nur unter Java zur Verfügung.

Der Typ des binären Inhalts sollte mit headers( "Content-Type" ) festgelegt werden (siehe HTTP/1.1 14.17 Content-Type)

charset_name

Zeichencodierung

String

web_service_response.charset_name

Beispiel in javascript

var request = spooler_task.order.web_service_operation.request;

spooler_log.info( request.header( "Content-Type" ) );   // ==> text/xml; charset=utf-8
spooler_log.info( request.content_type );               // ==> text/xml
spooler_log.info( request.charset_name );               // ==> utf-8

Zugriff auf den Parameter charset= aus dem Kopfeintrag Content-Type:.

content_type

Content-Type (ohne Parameter)

String

web_service_response.content_type

Zugriff auf den Kopfeintrag Content-Type: ohne dazugehörige Parameter (z.B. charset=).

Eintrag im Kopf

	web_service_response.header( String name ) = String value
String	web_service_response.header( String name )

Beispiel in javascript

spooler_log.info( "Content-Type: " + spooler_task.order.web_service_operation.header( "Content-Type" ) );

Parameter

value	Für einen umbekannten Eintrag wird `""` verwendet
name	Die Großschreibung spielt keine Rolle.

Rückgabe

String

Für einen umbekannten Eintrag wird "" verwendet

send

Antwort senden

web_service_response.send()

Exceptions

SCHEDULER-247 HTTP response has already been sent

status_code

HTTP-Status-Code

web_service_response.status_code = Integer

Voreingestellt ist 200 (OK).

Parameter

Integer

string_content

Nutzdaten als Text

web_service_response.string_content = String text

Beispiel in javascript

var response = spooler_task.order.web_service_operation.response;
response.content_type = "text/plain";
response.charset_name = "iso-8859-1";
response.string_content = "This is the answer";
response.send();

Zuvor muss header( "Content-Type" ) mit dem Parameter charset gesetzt sein, zum Beispiel

header( "Content-Type" ) = "text/plain; charset=iso-8859-1";

Der Text wird nach dem Parameter charset codiert. Fehlt der Parameter, wird ISO-8859-1 angenommen.

Zu den hier zulässigen Zeichen-Codierungen (Charset) siehe Web_service_request.string_content

Siehe Web_service_response.charset_name.

Parameter

text

Software- und Organisations-Service GmbH

Zuletzt geändert von Joacim Zschimmer, 2006-08-21