Package de.dlr.proseo.ordermgr.rest

Klasse OrbitControllerImpl

java.lang.Object

de.dlr.proseo.ordermgr.rest.OrbitControllerImpl

Alle implementierten Schnittstellen:

OrbitController

@Component
public class OrbitControllerImpl
extends Object
implements OrbitController

Spring MVC controller for the prosEO Order Manager; implements the services required to manage spacecraft orbits. This class provides endpoints for creating, retrieving, updating, and deleting spacecraft orbits.

Autor:

Ranjitha Vignesh

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
OrbitControllerImpl()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
org.springframework.http.ResponseEntity<String>	countOrbits(String spacecraftCode, Long orbitNumberFrom, Long orbitNumberTo, String startTimeFrom, String startTimeTo)	Retrieves the number of orbits matching the specified search criteria.
org.springframework.http.ResponseEntity<List<RestOrbit>>	createOrbits(@Valid List<RestOrbit> orbits)	Creates one or more orbits based on the provided JSON objects.
org.springframework.http.ResponseEntity<?>	deleteOrbitById(Long id)	Deletes the orbit with the given ID.
org.springframework.http.ResponseEntity<RestOrbit>	getOrbitById(Long id)	Retrieves the orbit with the given ID.
org.springframework.http.ResponseEntity<List<RestOrbit>>	getOrbits(String spacecraftCode, Long orbitNumberFrom, Long orbitNumberTo, String startTimeFrom, String startTimeTo, Integer recordFrom, Integer recordTo, String[] orderBy)	Retrieves a list of all orbits filtered by spacecraft code, orbit number range, and start time range.
org.springframework.http.ResponseEntity<RestOrbit>	modifyOrbit(Long id, @Valid RestOrbit orbit)	Updates the orbit with the given ID using the attribute values from the provided JSON object.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

OrbitControllerImpl

public OrbitControllerImpl()

Methodendetails

getOrbits

@Transactional(isolation=REPEATABLE_READ)
public org.springframework.http.ResponseEntity<List<RestOrbit>> getOrbits(String spacecraftCode,
 Long orbitNumberFrom,
 Long orbitNumberTo,
 String startTimeFrom,
 String startTimeTo,
 Integer recordFrom,
 Integer recordTo,
 String[] orderBy)

Retrieves a list of all orbits filtered by spacecraft code, orbit number range, and start time range.

Angegeben von:

getOrbits in Schnittstelle OrbitController

Parameter:

spacecraftCode - The spacecraft code to filter by.

orbitNumberFrom - The minimum orbit number requested.

orbitNumberTo - The maximum orbit number requested.

startTimeFrom - The earliest sensing start time requested.

startTimeTo - The latest sensing start time requested.

recordFrom - The first record of the filtered and ordered result to return.

recordTo - The last record of the filtered and ordered result to return.

orderBy - An array of strings containing a column name and an optional sort direction (ASC/DESC), separated by white space.

Gibt zurück:

HTTP status "OK" and a list of orbits if successful, or HTTP status "NOT_FOUND" and an error message if no orbits matching the search criteria were found, or HTTP status "BAD_REQUEST" and an error message if the request parameters were inconsistent, or HTTP status "FORBIDDEN" and an error message if a cross-mission data access was attempted, or HTTP status "INTERNAL_SERVER_ERROR" on any unexpected exception, or HTTP status "TOO MANY REQUESTS" if the result list exceeds a configured maximum.

countOrbits

@Transactional(isolation=REPEATABLE_READ)
public org.springframework.http.ResponseEntity<String> countOrbits(String spacecraftCode,
 Long orbitNumberFrom,
 Long orbitNumberTo,
 String startTimeFrom,
 String startTimeTo)

Retrieves the number of orbits matching the specified search criteria.

Angegeben von:

countOrbits in Schnittstelle OrbitController

Parameter:

spacecraftCode - The spacecraft code to filter by.

orbitNumberFrom - The minimum orbit number requested.

orbitNumberTo - The maximum orbit number requested.

startTimeFrom - The earliest sensing start time requested.

startTimeTo - The latest sensing start time requested.

Gibt zurück:

HTTP status "OK" and the number of retrieved orbits if successful, or HTTP status "NOT_FOUND" and an error message if no orbits matching the search criteria were found, or HTTP status "BAD_REQUEST" and an error message if the request parameters were inconsistent, or HTTP status "FORBIDDEN" and an error message if a cross-mission data access was attempted, or HTTP status "INTERNAL_SERVER_ERROR" on any unexpected exception.

createOrbits

public org.springframework.http.ResponseEntity<List<RestOrbit>> createOrbits(@Valid
 @Valid List<RestOrbit> orbits)

Creates one or more orbits based on the provided JSON objects.

Angegeben von:

createOrbits in Schnittstelle OrbitController

Parameter:

orbits - The list of JSON objects representing the orbits to create.

Gibt zurück:

HTTP status "CREATED" and a list of JSON objects corresponding to the created orbits if successful, or HTTP status "FORBIDDEN" and an error message if a cross-mission data access was attempted, or HTTP status "BAD_REQUEST" and an error message if the orbit data was invalid, or HTTP status "INTERNAL_SERVER_ERROR" and an error message if any other error occurred.

getOrbitById

public org.springframework.http.ResponseEntity<RestOrbit> getOrbitById(Long id)

Retrieves the orbit with the given ID.

Angegeben von:

getOrbitById in Schnittstelle OrbitController

Parameter:

id - The ID of the orbit to retrieve.

Gibt zurück:

HTTP status "OK" and a JSON object corresponding to the retrieved orbit if successful, or HTTP status "NOT_FOUND" and an error message if no orbit with the given ID exists, or HTTP status "FORBIDDEN" and an error message if a cross-mission data access was attempted, or HTTP status "INTERNAL_SERVER_ERROR" and an error message if any other error occurred.

modifyOrbit

public org.springframework.http.ResponseEntity<RestOrbit> modifyOrbit(Long id,
 @Valid
 @Valid RestOrbit orbit)

Updates the orbit with the given ID using the attribute values from the provided JSON object.

Angegeben von:

modifyOrbit in Schnittstelle OrbitController

Parameter:

id - The ID of the orbit to update.

orbit - The JSON object containing the modified (and unmodified) attributes.

Gibt zurück:

HTTP status "OK" and a JSON object corresponding to the updated orbit if successful, or HTTP status "NOT_FOUND" and an error message if no orbit with the given ID exists, or HTTP status "FORBIDDEN" and an error message if a cross-mission data access was attempted, or HTTP status "NOT_MODIFIED" if the update was unsuccessful, or HTTP status "INTERNAL_SERVER_ERROR" and an error message if any other error occurred.

deleteOrbitById

public org.springframework.http.ResponseEntity<?> deleteOrbitById(Long id)

Deletes the orbit with the given ID.

Angegeben von:

deleteOrbitById in Schnittstelle OrbitController

Parameter:

id - The ID of the orbit to delete.

Gibt zurück:

HTTP status "NO_CONTENT" if successful, or HTTP status "NOT_FOUND" and an error message if no orbit with the given ID exists, or HTTP status "FORBIDDEN" and an error message if a cross-mission data access was attempted, or HTTP status "INTERNAL_SERVER_ERROR" and an error message if any other error occurred.