APICodeService

java.lang.Object

org.deltava.service.WebService

org.deltava.service.simbrief.APICodeService

public class APICodeService extends WebService

A Web Service to generate SimBrief API codes.

Since:: 10.3
Version:: 10.3
Author:: Luke

Constructor Summary

Constructors

Constructor

Description

APICodeService()
Method Summary

Modifier and Type

Method

Description

int

execute(ServiceContext ctx)

Executes the Web Service.

final boolean

isLogged()

Returns whether this web service calls are logged.

final boolean

isSecure()

Returns whether this web service requires authentication.

Methods inherited from class org.deltava.service.WebService
error, error, error, getCount

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

Constructor Details
- APICodeService
  
  public APICodeService()
Method Details
- execute
  
  public int execute(ServiceContext ctx) throws ServiceException
  
  Executes the Web Service.
  
  Specified by:
  
  execute in class WebService
  
  Parameters:
  
  ctx - the Web Service context
  
  Returns:
  
  the HTTP status code
  
  Throws:
  
  ServiceException - if an error occurs
- isLogged
  
  public final boolean isLogged()
  
  Description copied from class: WebService
  
  Returns whether this web service calls are logged. High volume services like the Map/ServInfo route services will not be logged.
  
  Overrides:
  
  isLogged in class WebService
  
  Returns:
  
  TRUE if invocation logging should be performed by the servlet, otherwise FALSE
- isSecure
  
  public final boolean isSecure()
  
  Description copied from class: WebService
  
  Returns whether this web service requires authentication.
  
  Overrides:
  
  isSecure in class WebService
  
  Returns:
  
  TRUE if authentication is required, otherwise FALSE