org.eaglei.repository.model
Interface Transporter

All Known Implementing Classes:

TransportAccessGrant, TransportRole, TransportUser, TransportWorkflowTransition

public interface Transporter

All object models that can be subjects of the /export and /import services must implement this interface. Since hte process of serializing and deserializing complete, self-contained instances of the data is mostly unique logic, it belongs in a separate class.

Author:

Larry Stone Started March, 2011

Method Summary

void	authorizeExport(javax.servlet.http.HttpServletRequest request) Check that current authenticated user is authorized for this operation; some export requests require Superuser privilege.
void	authorizeImport(javax.servlet.http.HttpServletRequest request) Check that current authenticated user is authorized for this operation; some import requests require Superuser privilege.
void	doExport(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.openrdf.rio.RDFFormat format, java.util.Set<java.lang.String> includes, java.util.Set<java.lang.String> excludes) Serializes the selected objects to the HTTP response.
void	doImport(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.openrdf.repository.RepositoryConnection content, java.util.Set<java.lang.String> includes, java.util.Set<java.lang.String> excludes, ImportExport.DuplicateArg duplicate, boolean transform, boolean ignoreACL)

Method Detail

authorizeExport

void authorizeExport(javax.servlet.http.HttpServletRequest request)
                     throws javax.servlet.ServletException

Check that current authenticated user is authorized for this operation; some export requests require Superuser privilege. It is expected to throw a runtime HTTP status error, e.g. ForbiddenException, when access is denied.

Parameters:

request - the HTTP request object from servlet container

Throws:

javax.servlet.ServletException

authorizeImport

void authorizeImport(javax.servlet.http.HttpServletRequest request)
                     throws javax.servlet.ServletException

Check that current authenticated user is authorized for this operation; some import requests require Superuser privilege. It is expected to throw a runtime HTTP status error, e.g. ForbiddenException, when access is denied.

Parameters:

request - the HTTP request object from servlet container

Throws:

javax.servlet.ServletException

doExport

void doExport(javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response,
              org.openrdf.rio.RDFFormat format,
              java.util.Set<java.lang.String> includes,
              java.util.Set<java.lang.String> excludes)
              throws javax.servlet.ServletException,
                     java.io.IOException

Serializes the selected objects to the HTTP response.

Parameters:

request - the HTTP request object from servlet container

response - the HTTP response object from servlet container

format - the chosen output format

includes - restricted set of instances to include in the output; default is all

excludes - set of instances to exclude from the output, overrides includes

Throws:

javax.servlet.ServletException

java.io.IOException

doImport

void doImport(javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response,
              org.openrdf.repository.RepositoryConnection content,
              java.util.Set<java.lang.String> includes,
              java.util.Set<java.lang.String> excludes,
              ImportExport.DuplicateArg duplicate,
              boolean transform,
              boolean ignoreACL)
              throws javax.servlet.ServletException,
                     java.io.IOException

Parameters:

request - the HTTP request object from servlet container

response - the HTTP response object from servlet container

content - separate, temporary Sesame repository containing input RDF graph

includes - restricted set of instances allow to be ingested; default is all

excludes - set of instances to exclude from the ingest; overrides includes

duplicate - directive on how to handle duplicates of instances already in repository

transform - when true, transform the instance URI into new "local" URI

ignoreACL - when true, do not ingest the access control list (ACL), i.e. access grants

Throws:

javax.servlet.ServletException

java.io.IOException