Chapter 12: Using jagtool and jagant

refresh

Description

Refreshes an entity in the server.

Syntax

Local mode support: No.

Command line:

refresh connect-args entity

Ant build file:

<jag_refresh entity=”entity” />

Option	Description	Required
connect-args	Arguments to specify a connection to the server. See “Using connected mode”.	Yes
entity	The entity identifier for the entity being refreshed. To refresh servers, you must be connected to the specified server. To refresh other entities, you must be connected to a server in which the entity is installed. Refresh does not support servlets. To refresh servlets, refresh the Web application or server in which they are installed.	Yes

Option

Description

Required

connect-args

Arguments to specify a connection to the server. See “Using connected mode”.

Yes

entity

The entity identifier for the entity being refreshed. To refresh servers, you must be connected to the specified server. To refresh other entities, you must be connected to a server in which the entity is installed.

Refresh does not support servlets. To refresh servlets, refresh the Web application or server in which they are installed.

Yes

Returns

Return value	Indicates
0	The command ran successfully; the result is true/success.
2	The command did not run successfully; an exception was thrown.

Examples

Example 1

This example refreshes Package:SVU.

Command line:
```
jagtool refresh Package:SVU
```
Ant build file:
```
<jag_refresh entity="Package:SVU" />
```

Example 2

This example refreshes the SVULogin component of Package:SVU.

Command line:
```
jagtool refresh Component:SVU/SVULogin
```

Ant build file:

<jag_refresh entity="Component:SVU/SVULogin" />

Example 3

This example refreshes the Jaguar server, and works only when you are connected to the server with this name.

Command line:
```
jagtool refresh Server:Jaguar
```
Ant build file:
```
<jag_refresh entity="Server:Jaguar" />
```

View this book as PDF