|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.ucsb.nceas.metacat.client.MetacatClient
public class MetacatClient
This interface provides methods for initializing and logging in to a Metacat server, and then querying, reading, transforming, inserting, updating and deleting documents from that server.
| Constructor Summary | |
|---|---|
protected |
MetacatClient()
Constructor to create a new instance. |
| Method Summary | |
|---|---|
java.lang.String |
delete(java.lang.String docid)
Delete an XML document in the repository. |
java.lang.String |
getAccessControl(java.lang.String docid)
get the access control info for a given document id. |
java.util.Vector |
getAllDocids(java.lang.String scope)
return a list of all docids that match a given scope. |
java.lang.String |
getLastDocid(java.lang.String scope)
Return the highest document id for a given scope. |
java.lang.String |
getloggedinuserinfo()
Method used to log in to a metacat server. |
static MetacatClient |
getMetacatClient(javax.servlet.http.HttpServletRequest request)
JSP API: This is a convenience method to reduce the amount of code in a Metacat Client JSP. |
int |
getNewestDocRevision(java.lang.String docId)
The method will return the latest revision in metacat server for a given document id. |
java.lang.String |
getSessionId()
Get the session identifier for this session. |
java.lang.String |
insert(java.lang.String docid,
java.io.Reader xmlDocument,
java.io.Reader schema)
Insert an XML document into the repository. |
java.lang.String |
isAuthorized(java.lang.String resourceLsid,
java.lang.String permission,
java.lang.String sessionId)
Method used to log in to a metacat server. |
boolean |
isRegistered(java.lang.String docid)
return true of the given docid is registered, false if not |
java.lang.String |
login(java.lang.String username,
java.lang.String password)
Method used to log in to a metacat server. |
java.lang.String |
logout()
Method used to log out a metacat server. |
static void |
main(java.lang.String[] args)
|
java.io.Reader |
query(java.io.Reader xmlQuery)
Query the metacat document store with the given metacat-compatible query document and default qformat xml, and return the result set as a Reader. |
java.io.Reader |
query(java.io.Reader xmlQuery,
java.lang.String qformat)
Query the metacat document store with the given metacat-compatible query document and qformat, and return the result set as a Reader. |
java.io.InputStream |
read(java.lang.String docid)
Read an XML document from the metacat server session, accessed by docid, and returned as a Reader. |
java.io.InputStream |
readInlineData(java.lang.String inlinedataid)
Read inline data from the metacat server session, accessed by inlinedataid and returned as a Reader. |
java.io.InputStream |
sendData(java.util.Properties args,
java.util.Properties filename,
java.io.InputStream fileData,
int size)
Send a request to Metacat |
java.io.InputStream |
sendParameters(java.util.Properties args)
Send a request to Metacat. |
java.lang.String |
setAccess(java.lang.String docid,
java.lang.String accessBlock)
Set access for a given doc id. |
java.lang.String |
setAccess(java.lang.String docid,
java.lang.String principal,
java.lang.String permission,
java.lang.String permType,
java.lang.String permOrder)
set the access on an XML document in the repository. |
void |
setMetacatUrl(java.lang.String metacatUrl)
When the MetacatFactory creates an instance it needs to set the MetacatUrl to which connections should be made. |
void |
setSessionId(java.lang.String sessionId)
Set the session identifier for this session. |
java.lang.String |
update(java.lang.String docid,
java.io.Reader xmlDocument,
java.io.Reader schema)
Update an XML document in the repository. |
java.lang.String |
upload(java.lang.String docid,
java.io.File file)
Upload a data document into the repository. |
java.lang.String |
upload(java.lang.String docid,
java.lang.String filename,
java.io.InputStream fileData,
int size)
Upload a data document into the repository. |
java.lang.String |
validateSession(java.lang.String sessionId)
Method used to log in to a metacat server. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected MetacatClient()
| Method Detail |
|---|
public static void main(java.lang.String[] args)
public java.lang.String login(java.lang.String username,
java.lang.String password)
throws MetacatAuthException,
MetacatInaccessibleException
login in interface Metacatusername - the username of the user, like an LDAP DNpassword - the password for that user for authentication
MetacatAuthException - when the username/password could
not be authenticated
MetacatInaccessibleException
public java.lang.String getloggedinuserinfo()
throws MetacatInaccessibleException
getloggedinuserinfo in interface Metacatusername - the username of the user, like an LDAP DNpassword - the password for that user for authentication
MetacatAuthException - when the username/password could
not be authenticated
MetacatInaccessibleException
public java.lang.String logout()
throws MetacatInaccessibleException,
MetacatException
logout in interface MetacatMetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException
public java.lang.String validateSession(java.lang.String sessionId)
throws MetacatAuthException,
MetacatInaccessibleException
username - the username of the user, like an LDAP DNpassword - the password for that user for authentication
MetacatAuthException - when the username/password could
not be authenticated
MetacatInaccessibleException
public java.lang.String isAuthorized(java.lang.String resourceLsid,
java.lang.String permission,
java.lang.String sessionId)
throws MetacatAuthException,
MetacatInaccessibleException
username - the username of the user, like an LDAP DNpassword - the password for that user for authentication
MetacatAuthException - when the username/password could
not be authenticated
MetacatInaccessibleException
public java.io.InputStream read(java.lang.String docid)
throws InsufficientKarmaException,
MetacatInaccessibleException,
MetacatException,
DocumentNotFoundException
read in interface Metacatdocid - the identifier of the document to be read
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
DocumentNotFoundException
public java.io.InputStream readInlineData(java.lang.String inlinedataid)
throws InsufficientKarmaException,
MetacatInaccessibleException,
MetacatException
readInlineData in interface Metacatinlinedataid - the identifier of the data to be read
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
public java.io.Reader query(java.io.Reader xmlQuery)
throws MetacatInaccessibleException,
java.io.IOException
query in interface MetacatxmlQuery - a Reader for accessing the XML version of the query
MetacatInaccessibleException
java.io.IOException
public java.io.Reader query(java.io.Reader xmlQuery,
java.lang.String qformat)
throws MetacatInaccessibleException,
java.io.IOException
query in interface MetacatxmlQuery - a Reader for accessing the XML version of the queryqformat - the format of return doc. It can be xml, knb, lter and etal.
MetacatInaccessibleException
java.io.IOException
public java.lang.String insert(java.lang.String docid,
java.io.Reader xmlDocument,
java.io.Reader schema)
throws InsufficientKarmaException,
MetacatException,
java.io.IOException,
MetacatInaccessibleException
insert in interface Metacatdocid - the docid to insert the documentxmlDocument - a Reader for accessing the XML document to be insertedschema - a Reader for accessing the DTD or XML Schema for
the document
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
java.io.IOException - when there is an error reading the xml document
public java.lang.String update(java.lang.String docid,
java.io.Reader xmlDocument,
java.io.Reader schema)
throws InsufficientKarmaException,
MetacatException,
java.io.IOException,
MetacatInaccessibleException
update in interface Metacatdocid - the docid to updatexmlDocument - a Reader for accessing the XML text to be updatedschema - a Reader for accessing the DTD or XML Schema for
the document
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
java.io.IOException - when there is an error reading the xml document
public java.lang.String upload(java.lang.String docid,
java.io.File file)
throws InsufficientKarmaException,
MetacatException,
java.io.IOException,
MetacatInaccessibleException
upload in interface Metacatdocid - the identifier to be used for the documentfile - the File to be uploadeddocument - a InputStream containing the data to be uploaded
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
java.io.IOException - when there is an error reading the xml document
public java.lang.String upload(java.lang.String docid,
java.lang.String filename,
java.io.InputStream fileData,
int size)
throws InsufficientKarmaException,
MetacatException,
java.io.IOException,
MetacatInaccessibleException
upload in interface Metacatdocid - the identifier to be used for the documentfilename - the name to be used in the MIME description of the uploaded filedocument - a InputStream containing the data to be uploaded
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
java.io.IOException - when there is an error reading the xml document
public java.lang.String delete(java.lang.String docid)
throws InsufficientKarmaException,
MetacatException,
MetacatInaccessibleException
delete in interface Metacatdocid - the docid to delete
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
public java.lang.String getAccessControl(java.lang.String docid)
throws InsufficientKarmaException,
MetacatException,
MetacatInaccessibleException
getAccessControl in interface Metacat_docid - the docid of the document for which the access should be applied.
InsufficientKarmaException
MetacatException
MetacatInaccessibleException
public java.lang.String setAccess(java.lang.String docid,
java.lang.String principal,
java.lang.String permission,
java.lang.String permType,
java.lang.String permOrder)
throws InsufficientKarmaException,
MetacatException,
MetacatInaccessibleException
setAccess in interface Metacat_docid - the docid of the document for which the access should be applied._principal - the document's principal_permission - the access permission to be applied to the docid
{e.g. read,write,all}_permType - the permission type to be applied to the document
{e.g. allow or deny}_permOrder - the order that the document's permissions should be
processed {e.g. denyFirst or allowFirst}
InsufficientKarmaException - when the user has insufficent rights
for the operation
MetacatInaccessibleException - when the metacat server can not be
reached or does not respond
MetacatException - when the metacat server generates another error
public java.lang.String setAccess(java.lang.String docid,
java.lang.String accessBlock)
throws InsufficientKarmaException,
MetacatException,
MetacatInaccessibleException
setAccess in interface Metacatdocid - the doc id for the doc we want to updateaccessBlock - the xml access block. This is the same structure as that
returned by the getdocumentinfo action in metacat.
InsufficientKarmaException
MetacatException
MetacatInaccessibleExceptionpublic void setMetacatUrl(java.lang.String metacatUrl)
setMetacatUrl in interface MetacatmetacatUrl - the URL for the metacat serverpublic java.lang.String getSessionId()
getSessionId in interface Metacatpublic void setSessionId(java.lang.String sessionId)
setSessionId in interface MetacatString - the sessionId from a previously established session
public int getNewestDocRevision(java.lang.String docId)
throws MetacatException
getNewestDocRevision in interface MetacatdocId - String the given docid you want to use. the docid it self
can have or haven't revision number
MetacatException
public java.lang.String getLastDocid(java.lang.String scope)
throws MetacatException
getLastDocid in interface Metacatscope - String the scope to use for looking up the latest id
MetacatException - when an error occurs
public java.util.Vector getAllDocids(java.lang.String scope)
throws MetacatException
getAllDocids in interface Metacatscope - String the scope to use to limit the docid query
MetacatException - when an error occurs
public boolean isRegistered(java.lang.String docid)
throws MetacatException
isRegistered in interface Metacatscope - String the scope to use to limit the docid query
MetacatException - when an error occurs
public java.io.InputStream sendParameters(java.util.Properties args)
throws java.lang.Exception
args - Properties of the parameters to be sent to Metacat, where,
key = param value
value = param name
java.lang.Exception - thrown
public java.io.InputStream sendData(java.util.Properties args,
java.util.Properties filename,
java.io.InputStream fileData,
int size)
throws java.lang.Exception
args - the properties to be sent to Metacatfilename - the properties to be sent to Metacat
in case of upload, otherwise nullfileData - the inputStream for the file data to be sent to Metacat
in case of upload, otherwise nullsize - the size of the data being sent to Metacat
in case of upload, otherwise 0
java.lang.Exception
public static MetacatClient getMetacatClient(javax.servlet.http.HttpServletRequest request)
throws MetacatInaccessibleException
request - Since this is intended to be used by a JSP, it is passed the
available "request" variable (the HttpServletRequest).
MetacatInaccessibleException - Received by MetacatFactory.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||