ServiceCall (Jadex Active Component Platform 3.0.117 API)

java.lang.Object
- jadex.bridge.ServiceCall

Direct Known Subclasses:

CallAccess
```
public class ServiceCall
extends java.lang.Object
```
Information about a current service call. Similar to a ThreadLocal in Java but for service calls, i.e. between different threads and hosts available.

Field Summary

Fields
Modifier and Type	Field and Description
`protected IComponentIdentifier`	`caller` The calling component.
`static java.lang.String`	`CAUSE` The cause constant.
`protected static java.lang.ThreadLocal<ServiceCall>`	`CURRENT` The current service calls mapped to threads.
`static java.lang.String`	`DEFTIMEOUT`
`static java.lang.String`	`INHERIT` The inherit constant.
`protected static java.lang.ThreadLocal<ServiceCall>`	`LAST` The upcoming service invocations.
`IComponentIdentifier`	`lastmod`
`static java.lang.String`	`MONITORING` The monitoring constant.
`protected static java.lang.ThreadLocal<ServiceCall>`	`NEXT` The upcoming service invocations.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`properties` The service call properties.
`static java.lang.String`	`REALTIME` The realtime constant.
`static java.lang.String`	`TIMEOUT` The timeout constant.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ServiceCall(IComponentIdentifier caller, java.util.Map<java.lang.String,java.lang.Object> props)` Create a service call info object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static ServiceCall`	`createServiceCall(IComponentIdentifier caller, java.util.Map<java.lang.String,java.lang.Object> props)` Create a service call.
`IComponentIdentifier`	`getCaller()` Get the caller component.
`Cause`	`getCause()` Get the cause.
`static ServiceCall`	`getCurrentInvocation()` Get the service call instance corresponding to the current execution context.
`static ServiceCall`	`getLastInvocation()` Get the last service call instance corresponding to the current execution context.
`static ServiceCall`	`getNextInvocation()` Get the invocation data for the next service call.
`static ServiceCall`	`getOrCreateNextInvocation()` Set the properties of the next invocation.
`static ServiceCall`	`getOrCreateNextInvocation(java.util.Map<java.lang.String,java.lang.Object> props)` Get or create the next servicecall for the next invocation.
`java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()` Get a property.
`java.lang.Object`	`getProperty(java.lang.String name)` Get a property.
`java.lang.Boolean`	`getRealtime()` Get the realtime flag.
`long`	`getTimeout()` Get the timeout value.
`boolean`	`hasUserTimeout()` Test if the user has set a timeout.
`boolean`	`isRealtime()` Get the realtime flag.
`void`	`removeProperty(java.lang.String name)` Remove a property.
`void`	`setCause(Cause cause)` Set the cause.
`void`	`setProperty(java.lang.String name, java.lang.Object val)` Set a property.
`void`	`setRealtime(java.lang.Boolean realtime)` Set the realtime property.
`void`	`setTimeout(long to)` Set the timeout.
`java.lang.String`	`toString()` Get the string represntation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TIMEOUT
```
public static final java.lang.String TIMEOUT
```
    The timeout constant.
    
    See Also:
    
    Constant Field Values
  - DEFTIMEOUT
```
public static final java.lang.String DEFTIMEOUT
```
    See Also:
    
    Constant Field Values
  - REALTIME
```
public static final java.lang.String REALTIME
```
    The realtime constant.
    
    See Also:
    
    Constant Field Values
  - CAUSE
```
public static final java.lang.String CAUSE
```
    The cause constant.
    
    See Also:
    
    Constant Field Values
  - MONITORING
```
public static final java.lang.String MONITORING
```
    The monitoring constant.
    
    See Also:
    
    Constant Field Values
  - INHERIT
```
public static final java.lang.String INHERIT
```
    The inherit constant.
    
    See Also:
    
    Constant Field Values
  - CURRENT
```
protected static final java.lang.ThreadLocal<ServiceCall> CURRENT
```
    The current service calls mapped to threads.
  - NEXT
```
protected static final java.lang.ThreadLocal<ServiceCall> NEXT
```
    The upcoming service invocations.
  - LAST
```
protected static final java.lang.ThreadLocal<ServiceCall> LAST
```
    The upcoming service invocations.
  - caller
```
protected IComponentIdentifier caller
```
    The calling component.
  - properties
```
protected java.util.Map<java.lang.String,java.lang.Object> properties
```
    The service call properties.
  - lastmod
```
public IComponentIdentifier lastmod
```
- Constructor Detail
  - ServiceCall
```
protected ServiceCall(IComponentIdentifier caller,
                      java.util.Map<java.lang.String,java.lang.Object> props)
```
    Create a service call info object.
- Method Detail
  - createServiceCall
```
protected static ServiceCall createServiceCall(IComponentIdentifier caller,
                                               java.util.Map<java.lang.String,java.lang.Object> props)
```
    Create a service call.
  - getNextInvocation
```
public static ServiceCall getNextInvocation()
```
    Get the invocation data for the next service call.
  - getCurrentInvocation
```
public static ServiceCall getCurrentInvocation()
```
    Get the service call instance corresponding to the current execution context.
    
    Returns:
    
    The service call instance or null.
  - getLastInvocation
```
public static ServiceCall getLastInvocation()
```
    Get the last service call instance corresponding to the current execution context.
    
    Returns:
    
    The service call instance or null.
  - getOrCreateNextInvocation
```
public static ServiceCall getOrCreateNextInvocation()
```
    Set the properties of the next invocation.
    
    Parameters:
    
    timeout - The timeout.
    
    realtime - The realtime flag.
  - getOrCreateNextInvocation
```
public static ServiceCall getOrCreateNextInvocation(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Get or create the next servicecall for the next invocation.
    
    Parameters:
    
    timeout - The timeout.
    
    realtime - The realtime flag.
  - getCaller
```
public IComponentIdentifier getCaller()
```
    Get the caller component.
    
    Returns:
    
    The caller component.
  - getTimeout
```
public long getTimeout()
```
    Get the timeout value.
    
    Returns:
    
    The timeout value or -1.
  - hasUserTimeout
```
public boolean hasUserTimeout()
```
    Test if the user has set a timeout.
    
    Returns:
    
    True, if the user has set a timeout.
  - setTimeout
```
public void setTimeout(long to)
```
    Set the timeout.
    
    Parameters:
    
    to - The timeout.
  - getRealtime
```
public java.lang.Boolean getRealtime()
```
    Get the realtime flag.
    
    Returns:
    
    True, if the timeout is a real time (i.e. system time) instead of platform time.
  - setRealtime
```
public void setRealtime(java.lang.Boolean realtime)
```
    Set the realtime property.
  - isRealtime
```
public boolean isRealtime()
```
    Get the realtime flag.
    
    Returns:
    
    True, if the timeout is a real time (i.e. system time) instead of platform time.
  - getCause
```
public Cause getCause()
```
    Get the cause.
    
    Returns:
    
    The cause.
  - setCause
```
public void setCause(Cause cause)
```
    Set the cause.
    
    Parameters:
    
    cause - The cause.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    Get a property.
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    The property.
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.Object val)
```
    Set a property.
    
    Parameters:
    
    name - The property name.
    
    val - The property value.
  - removeProperty
```
public void removeProperty(java.lang.String name)
```
    Remove a property.
    
    Parameters:
    
    name - The property name.
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getProperties()
```
    Get a property.
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    The property.
  - toString
```
public java.lang.String toString()
```
    Get the string represntation.
    
    Overrides:
    
    toString in class java.lang.Object

Class ServiceCall

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIMEOUT

DEFTIMEOUT

REALTIME

CAUSE

MONITORING

INHERIT

CURRENT

NEXT

LAST

caller

properties

lastmod

Constructor Detail

ServiceCall

Method Detail

createServiceCall

getNextInvocation

getCurrentInvocation

getLastInvocation

getOrCreateNextInvocation

getOrCreateNextInvocation

getCaller

getTimeout

hasUserTimeout

setTimeout

getRealtime

setRealtime

isRealtime

getCause

setCause

getProperty

setProperty

removeProperty

getProperties

toString