|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IProviderSession
Provider session. This session established by the Agent runtime system with a content provider (external system).
There could be numerous providers per a single connector. Each of these providers can hold its own properties, e.g. credential sets.
Method Summary | |
---|---|
IRepository |
createRepository(RepositoryInfo rinfo)
Creates a new repository. |
int |
deleteRepositories(java.util.List<java.lang.String> repids)
Deletes repositories. |
void |
disconnect()
Desconnects this session. |
Properties |
getProperties()
Gets this provider session custom properties. |
java.util.List<IRepository> |
getRepositories()
Get the list of all repositories available via this provider. |
IRepository |
getRepositoryByID(java.lang.String repid)
Gets repository by its unique identifier. |
ProviderState |
getState()
Gets state of this provider session. |
void |
sendHeartbeat(HeartbeatInfo hinfo)
Sends heartbeat message to the system represented by this provider. |
IRepository |
updateRepository(RepositoryInfo rinfo)
Updates reposotory information (name, custom properties). |
Method Detail |
---|
void disconnect() throws AgentException
AgentException
- if error occures during the disconnect operation.Properties getProperties()
ProviderState getState()
void sendHeartbeat(HeartbeatInfo hinfo) throws AgentException
HeartbeatState
set to HeartbeatState.Normal
.
Before Agent shuts down SendHeartbeat methods from all providers
are invoked the last time with HeartbeatState
set to HeartbeatState.Stopping
.
AgentException
- if the provider failed to send a hearbeat message.java.util.List<IRepository> getRepositories() throws AgentException
AgentException
- if the provider failed to extract the list of repositories.IRepository getRepositoryByID(java.lang.String repid) throws NotFoundException, AgentException
id
- repository unique identifier.
NotFoundException
- if the repository asked doesn't exits.
AgentException
- if the repository could not be retrieved.IRepository createRepository(RepositoryInfo rinfo) throws AgentException
rinfo
- repository information block with name set.
AgentException
- if the repository could not be created.IRepository updateRepository(RepositoryInfo rinfo) throws AgentException
rinfo
- repository info to update.
AgentException
- if the repository could not be updated.int deleteRepositories(java.util.List<java.lang.String> repids) throws AgentException
repids
- the list of repository identifiers.
AgentException
- if an error occured during the deletion operation.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |