org.openepics.cable.util.fbs

Class FbsClient

java.lang.Object

org.openepics.cable.util.fbs.FbsClient

All Implemented Interfaces:

AutoCloseable

public class FbsClient
extends Object
implements AutoCloseable

Client to ITIP integration platform for retrieval of CHESS data and extraction of information such as cable name, ESS name, CHESS id, FBS tag.

ITIP is considered and treated as a web service from which data is retrieved.

Author:

Lars Johansson, Zoltan Runyo

See Also:

FbsElement

Constructor Summary

Constructors

Constructor and Description
FbsClient(String url) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
List<FbsElement>	getFbsListing() Retrieve (all) FBS data and deserializes it into a FbsElement list.
List<FbsElement>	getFbsListingForCableName(String cableName) Retrieve FBS data for cable name and deserializes it into a FbsElement list.
List<FbsElement>	getFbsListingForEssName(String essName) Retrieve FBS data for ESS name and deserializes it into a FbsElement list.
List<FbsElement>	getFbsListingForId(String id) Retrieve FBS data for id and deserializes it into a FbsElement list.
List<FbsElement>	getFbsListingForTag(String tag) Retrieve FBS data for FBS tag and deserializes it into a FbsElement list.
List<FbsElement>	getFbsListingForTag(String tag, int maxResults) Retrieve FBS data for FBS tag and deserializes it into a FbsElement list of up to maxResults elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FbsClient

public FbsClient(String url)

Constructor.

Parameters:

url - base URL of FBS webservice.

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

getFbsListing

public List<FbsElement> getFbsListing()

Retrieve (all) FBS data and deserializes it into a FbsElement list.

Note no parameter.

Returns:

List of all FbsElement

getFbsListingForCableName

public List<FbsElement> getFbsListingForCableName(String cableName)

Retrieve FBS data for cable name and deserializes it into a FbsElement list.

Note

• null returned if empty or null parameter
• method encodes given parameter

Parameters:

cableName - cable name

Returns:

List of matching FbsElement

getFbsListingForEssName

public List<FbsElement> getFbsListingForEssName(String essName)

Retrieve FBS data for ESS name and deserializes it into a FbsElement list.

Note

• null returned if empty or null parameter
• method encodes given parameter

Parameters:

essName - ESS name

Returns:

List of matching FbsElement

getFbsListingForId

public List<FbsElement> getFbsListingForId(String id)

Retrieve FBS data for id and deserializes it into a FbsElement list.

Note

• null returned if empty or null value parameter
• method encodes given parameter

Parameters:

tag - FBS tag

Returns:

List of matching FbsElement

getFbsListingForTag

public List<FbsElement> getFbsListingForTag(String tag)

Retrieve FBS data for FBS tag and deserializes it into a FbsElement list.

Note

• null returned if empty or null value parameter
• method encodes given parameter

Parameters:

tag - FBS tag

Returns:

List of matching FbsElement

getFbsListingForTag

public List<FbsElement> getFbsListingForTag(String tag,
                                            int maxResults)

Retrieve FBS data for FBS tag and deserializes it into a FbsElement list of up to maxResults elements.

Note

• null returned if empty or null value parameter
• null returned if negative maxResults parameter
• method encodes given parameter

Parameters:

tag - query, FBS tag part

maxResults - maximum number of results

Returns:

List of matching FbsElement