com.rsmart.kuali.coeus.hr.rest

Class HRImportResource

java.lang.Object

com.rsmart.kuali.coeus.hr.rest.HRImportResource

@Path(value="hrimport")
public class HRImportResource
extends Object

This is the main REST resource which defines the endpoints for HR import. It uses the Jersey implementation of JAX-RS. Therefore all configuration is accomplished via java.ws.rs annotations. The base path for this resource is "/hrimport". Specific REST calls: /import [POST] expects multipart form data with a single file (named "file") included. This file should be an XML document conforming to hrmanifest.xsd /delete/<principal ID> [DELETE] deletes the Entity and all dependent objects represented by principal ID.

Author:

duffy

Field Summary

Fields

Modifier and Type	Field and Description
static String	HR_IMPORT_IN_MEMORY
protected Schema	hrImportSchema The schema for validation.
protected Unmarshaller	hrImportUnmarshaller Parses the incoming XML document
static String	IMPORT_SERVICE_NAME
protected ImportRunner	importRunner
protected HRImportService	importService HRImportService implements the business logic to preform the import.
protected JAXBContext	jaxbContext JAXB innards
static String	SCHEMA_PATH
protected ImportStatusService	statusService

Constructor Summary

Constructors

Constructor and Description
HRImportResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	abort(String importId)
javax.ws.rs.core.Response	deleteRecord(String entityId) Deletes a single person by his/her entity ID
ImportRunner	getImportRunner()
HRImportService	getImportService() If an instance of HRImportService has been provided via setImportService(...) it will be returned here.
ImportStatusService	getStatusService()
javax.ws.rs.core.Response	processImport(InputStream uploadedInputStream) Processes an incoming multipart form with a "file" argument.
protected boolean	runInMemory()
void	setImportRunner(ImportRunner runner)
void	setImportService(HRImportService importService)
void	setStatusService(ImportStatusService svc)
javax.ws.rs.core.Response	status(String importId)
String	statusToJson(ImportStatus status)
javax.ws.rs.core.Response	unmanagedPrincipals()

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_PATH

public static final String SCHEMA_PATH

See Also:

Constant Field Values

IMPORT_SERVICE_NAME

public static final String IMPORT_SERVICE_NAME

See Also:

Constant Field Values

HR_IMPORT_IN_MEMORY

public static final String HR_IMPORT_IN_MEMORY

See Also:

Constant Field Values

importService

protected transient HRImportService importService

HRImportService implements the business logic to preform the import.

importRunner

protected transient ImportRunner importRunner

statusService

protected transient ImportStatusService statusService

jaxbContext

protected transient JAXBContext jaxbContext

JAXB innards

hrImportSchema

protected transient Schema hrImportSchema

The schema for validation.

hrImportUnmarshaller

protected transient Unmarshaller hrImportUnmarshaller

Parses the incoming XML document

Constructor Detail

HRImportResource

public HRImportResource()
                 throws Exception

Throws:

Exception

Method Detail

statusToJson

public String statusToJson(ImportStatus status)

runInMemory

protected final boolean runInMemory()

processImport

@POST
 @Path(value="/import")
 @Consumes(value="multipart/form-data")
public javax.ws.rs.core.Response processImport(InputStream uploadedInputStream)
                                                                                                              throws Exception

Processes an incoming multipart form with a "file" argument. The file is an HR import that must conform to hrimport.xsd. Return codes: 200 import ok 400 bad request 401 access denied 500 server error

Parameters:

uploadedInputStream -

Returns:

Throws:

Exception

abort

@DELETE
 @Path(value="/import/{importId}")
public javax.ws.rs.core.Response abort(@PathParam(value="importId")
                                                                                  String importId)

status

@GET
 @Path(value="/import/{importId}")
public javax.ws.rs.core.Response status(@PathParam(value="importId")
                                                                                String importId)

deleteRecord

@DELETE
 @Path(value="/delete/{entityId}")
public javax.ws.rs.core.Response deleteRecord(@PathParam(value="entityId")
                                                                                         String entityId)

Deletes a single person by his/her entity ID

Parameters:

entityId -

Returns:

unmanagedPrincipals

@GET
 @Path(value="/principals/unmanaged")
public javax.ws.rs.core.Response unmanagedPrincipals()

getImportService

public HRImportService getImportService()

If an instance of HRImportService has been provided via setImportService(...) it will be returned here. Otherwise a new HRImportServiceImpl will be created. KRA and RICE service locators will be used to populate its dependencies.

Returns:

setImportService

public void setImportService(HRImportService importService)

getStatusService

public ImportStatusService getStatusService()

setStatusService

public void setStatusService(ImportStatusService svc)

getImportRunner

public ImportRunner getImportRunner()

setImportRunner

public void setImportRunner(ImportRunner runner)