Page History

{div:style=}

Wiki Markup

Div

style	display:none

DO

NOT

EDIT

THE

CONTENT

OF

THIS

PAGE

DIRECTLY

(EXCEPT

INSIDE

THE

DIV

BELOW

WITH

ID=DESCRIPTION),

UNLESS

YOU

KNOW

WHAT

YOU'RE

DOING.

THE

STRUCTURE

OF

THE

CONTENT

IS

VITAL

IN

BEING

ABLE

TO

AUTO

UPDATE

THE

CONTENT

THROUGH

THE

DOC

GENERATOR.

\\ \\ Enter additional information related to this

Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}h3. Starting Headless Clients from Debug Clients in Servoy Developer When starting a Headless Client from a Debug Client in Servoy Developer, there are restrictions to which solution can be started in the Headless Client. * Prior to Servoy

Div

id	description

Starting Headless Clients from Debug Clients in Servoy Developer

When starting a Headless Client from a Debug Client in Servoy Developer, there are restrictions to which solution can be started in the Headless Client.

Prior to Servoy 6.1.1,

...

the

...

Headless

...

Client

...

would

...

always

...

start

...

with

...

the

...

Active

...

Solution,

...

regardless

...

which

...

solution

...

would

...

be

...

specified

...

As

...

of

...

Servoy

...

6.1.1

...

the

...

specified

...

solution

...

will

...

be

...

honored,

...

as

...

long

...

as

...

the

...

specified

...

solution

...

is

...

the

...

Active

...

Solution

...

or

...

a

...

solution/module

...

included

...

in

...

the

...

Active

...

Solution

...

By

...

default

...

the

...

Headless

...

Client

...

which

...

is

...

started

...

will

...

be

...

a

...

debug-able

...

Headless

...

Client.

...

As

...

there

...

can

...

only

...

one

...

debug-able

...

Client

...

of

...

a

...

specific

...

type

...

at

...

the

...

same

...

time

...

(so

...

one

...

debug-able

...

Web

...

Client,

...

one

...

debug-able

...

Smart

...

Client

...

and

...

one

...

debug-able

...

Headless

...

Client),

...

starting

...

a

...

new

...

debug-able

...

Headless

...

Client

...

will

...

close

...

an

...

existent

...

debug-able

...

Headless

...

Client.

...

It's

...

possible

...

to

...

start

...

non-debug-able

...

Headless

...

Clients

...

using

...

the

...

Headless

...

Client

...

plugin

...

while

...

in

...

Servoy

...

Developer

...

by

...

sending

...

in

...

the

...

value

...

"nodebug"

...

as

...

the

...

last

...

value

...

in

...

the

...

"solutionOpenMethodArgs"

...

array

...

parameter.

...

In

...

this

...

case

...

it

...

is

...

also

...

possible

...

to

...

start

...

the

...

Headless

...

Client

...

with

...

a

...

solution/module

...

that

...

isn't

...

the

...

Active

...

Solution

...

or

...

one

...

of

...

it's

...

modules,

...

as

...

long

...

as

...

the

...

specified

...

solution

...

is

...

available

...

in

...

the

...

workspace

...

and

...

uses

...

the

...

same

...

Resources

...

project

...

as

...

the

...

Active

...

Solution

HTML Table

id
class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSClient

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSClient

Table Cell (td)
#createClient(solutionName, username, password, solutionOpenMethodArgs) Creates a headless client on the server that will open the given solution.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSClient

Table Cell (td)
#getClient(clientID) Gets an existing headless client for the given client uuid.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSClient

Table Cell (td)
#getOrCreateClient(clientId, solutionname, username, password, solutionOpenMethodArgs) This will try to get a existing client by the given id if that client is already created for that specific solution; it will create a headless client on the server that will open the given solution if it didn't exists yet.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	createClient-String_String_String_ObjectArray

}{

Table Row (tr)

:

id

=

	name

}{td}h6.createClient{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
createClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}[

JSClient

]{span}{span:style=

Span

style	font-weight:

bold;

}

createClient

{span}{span}\

Span
(solutionName,

username,

password,

solutionOpenMethodArgs)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Creates a headless client on the server that will open the given solution. The clientId of this client can be stored in the database to be shared between clients so that that specific client can be used over multiply clients later on or picked up later on by this client. (Even after restart of this client) NOTE: in the developer this will only load the solution in debug mode when it is the current active solution or a module of the active solution; you can load any solution from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project). But then you won't be able to debug it, breakpoints won't hit.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} solutionName \{[String]} username \{[String]} password \{[Object]\[]} solutionOpenMethodArgs {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSClient]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a headless client on the server that will open the given solution.
The clientId of this client can be stored in the database to be shared between clients so that that specific client can be used
over multiply clients later on or picked up later on by this client. (Even after restart of this client)

NOTE: in the developer this will only load the solution in debug mode when it is the current active solution or a module of the active solution;
you can load any solution from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project).
But then you won't be able to debug it, breakpoints won't hit.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} solutionName
{String} username
{String} password
{Object[]} solutionOpenMethodArgs

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


// Creates a headless client that will open the given solution.
var headlessClient = plugins.headlessclient.createClient("someSolution", "user", "pass", null);
if (headlessClient != null && headlessClient.isValid()) { 
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	headlessClient.queueMethod(null, "remoteMethod", [x], callback);
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClient-String}{tr:id=name}{td}h6.getClient{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSClient]{span}{span:style=font-weight: bold;}getClient{span}{span}\(clientID){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets an existing headless client for the given client uuid.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} clientID {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSClient]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getClient-String

Table Row (tr)

id	name

Table Cell (td)
getClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSClient

Span

style	font-weight: bold;

getClient

Span
(clientID)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing headless client for the given client uuid.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} clientID

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


// Gets an existing headless client for the given client uuid.
var headlessClient = plugins.headlessclient.getClient("clientID");
if (headlessClient != null && headlessClient.isValid()) {
	 headlessClient.queueMethod(null, "someRemoteMethod", null, callback);
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getOrCreateClient-String_String_String_String_ObjectArray

}{

Table Row (tr)

:

id

=

	name

}{td}h6.getOrCreateClient{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
getOrCreateClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}[

JSClient

]{span}{span:style=

Span

style	font-weight:

bold;

}

getOrCreateClient

{span}{span}\

Span
(clientId,

solutionname,

username,

password,

solutionOpenMethodArgs)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}This will try to get a existing client by the given id if that client is already created for that specific solution; it will create a headless client on the server that will open the given solution if it didn't exists yet. If the client does exist but it is not loaded with that solution an exception will be thrown. NOTE: in the developer this will only load the solution in debug mode when it is the current active solution or a module of the active solution; you can load any solution from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project). But then you won't be able to debug it, breakpoints won't hit.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} clientId -- The id of the client if it already exists, or it will be the id of the client if it will be created. \{[String]} solutionname -- The solution to load \{[String]} username -- The user name that is used to login to the solution \{[String]} password -- The password for the user \{[Object]\[]} solutionOpenMethodArgs -- The arguments that will be passed to the solution open method. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSClient] -- An existing JSClient or the JSClient that is created.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

This will try to get a existing client by the given id if that client is already created for that specific solution;
it will create a headless client on the server that will open the given solution if it didn't exists yet.

If the client does exist but it is not loaded with that solution an exception will be thrown.

NOTE: in the developer this will only load the solution in debug mode when it is the current active solution or a module of the active solution;
you can load any solution from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project).
But then you won't be able to debug it, breakpoints won't hit.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} clientId – The id of the client if it already exists, or it will be the id of the client if it will be created.
{String} solutionname – The solution to load
{String} username – The user name that is used to login to the solution
{String} password – The password for the user
{Object[]} solutionOpenMethodArgs – The arguments that will be passed to the solution open method.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSClient – An existing JSClient or the JSClient that is created.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


// Creates a headless client that will open the given solution.
var storedSolutionSpecificID = "aaaabbbbccccc1111";
var headlessClient = plugins.headlessclient.getOrCreateClient(storedSolutionSpecificID, "someSolution", "user", "pass", null);
if (headlessClient != null && headlessClient.isValid()) { 
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	headlessClient.queueMethod(null, "remoteMethod", [x], callback);
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 20

New Version 21

Key

Starting Headless Clients from Debug Clients in Servoy Developer

createClient

getClient

getOrCreateClient