Package org.opennms.netmgt.provision.persist

Interface ForeignSourceRepository

All Known Implementing Classes:

AbstractForeignSourceRepository, CachingForeignSourceRepository, FasterFilesystemForeignSourceRepository, FilesystemForeignSourceRepository, FusedForeignSourceRepository, QueueingForeignSourceRepository

public interface ForeignSourceRepository

ForeignSourceRepository interface.

Author:

Benjamin Reed, Matt Brozowski

Method Summary

Modifier and Type	Method	Description
void	clear()	Delete all requisitions and foreign source definitions and return to defaults.
void	delete(ForeignSource foreignSource)	delete
void	delete(Requisition requisition)	delete
void	flush()	For performance reasons, a get after a save on a ForeignSourceRepository is not guaranteed to return the latest saved data unless you flush first.
Set<String>	getActiveForeignSourceNames()	getActiveForeignSourceNames
ForeignSource	getDefaultForeignSource()	getDefaultForeignSource
ForeignSource	getForeignSource(String foreignSourceName)	getForeignSource
int	getForeignSourceCount()	getForeignSourceCount
Set<ForeignSource>	getForeignSources()	getForeignSources
OnmsNodeRequisition	getNodeRequisition(String foreignSource, String foreignId)	getNodeRequisition
Requisition	getRequisition(String foreignSourceName)	getRequisition
Requisition	getRequisition(ForeignSource foreignSource)	getRequisition
Date	getRequisitionDate(String foreignSource)	getRequisitionDate
Set<Requisition>	getRequisitions()	getRequisitions
URL	getRequisitionURL(String foreignSource)	getRequisitionURL
Requisition	importResourceRequisition(org.springframework.core.io.Resource resource)	importResourceRequisition
void	putDefaultForeignSource(ForeignSource foreignSource)	putDefaultForeignSource
void	resetDefaultForeignSource()	resetDefaultForeignSource
void	save(ForeignSource foreignSource)	save
void	save(Requisition requisition)	save
void	validate(ForeignSource foreignSource)
void	validate(Requisition requisition)

Method Detail

getActiveForeignSourceNames

Set<String> getActiveForeignSourceNames()

getActiveForeignSourceNames

Returns:

a Set object.

getForeignSourceCount

int getForeignSourceCount()
                   throws ForeignSourceRepositoryException

getForeignSourceCount

Returns:

a int.

Throws:

ForeignSourceRepositoryException - if any.

getForeignSources

Set<ForeignSource> getForeignSources()
                              throws ForeignSourceRepositoryException

getForeignSources

Returns:

a Set object.

Throws:

ForeignSourceRepositoryException - if any.

getForeignSource

ForeignSource getForeignSource(String foreignSourceName)
                        throws ForeignSourceRepositoryException

getForeignSource

Parameters:

foreignSourceName - a String object.

Returns:

a ForeignSource object.

Throws:

ForeignSourceRepositoryException - if any.

save

void save(ForeignSource foreignSource)
   throws ForeignSourceRepositoryException

save

Parameters:

foreignSource - a ForeignSource object.

Throws:

ForeignSourceRepositoryException - if any.

delete

void delete(ForeignSource foreignSource)
     throws ForeignSourceRepositoryException

delete

Parameters:

foreignSource - a ForeignSource object.

Throws:

ForeignSourceRepositoryException - if any.

getDefaultForeignSource

ForeignSource getDefaultForeignSource()
                               throws ForeignSourceRepositoryException

getDefaultForeignSource

Returns:

a ForeignSource object.

Throws:

ForeignSourceRepositoryException - if any.

putDefaultForeignSource

void putDefaultForeignSource(ForeignSource foreignSource)
                      throws ForeignSourceRepositoryException

putDefaultForeignSource

Parameters:

foreignSource - a ForeignSource object.

Throws:

ForeignSourceRepositoryException - if any.

resetDefaultForeignSource

void resetDefaultForeignSource()
                        throws ForeignSourceRepositoryException

resetDefaultForeignSource

Throws:

ForeignSourceRepositoryException - if any.

importResourceRequisition

Requisition importResourceRequisition(org.springframework.core.io.Resource resource)
                               throws ForeignSourceRepositoryException

importResourceRequisition

Parameters:

resource - a Resource object.

Returns:

a Requisition object.

Throws:

ForeignSourceRepositoryException - if any.

getRequisitions

Set<Requisition> getRequisitions()
                          throws ForeignSourceRepositoryException

getRequisitions

Returns:

a Set object.

Throws:

ForeignSourceRepositoryException - if any.

getRequisition

Requisition getRequisition(String foreignSourceName)
                    throws ForeignSourceRepositoryException

getRequisition

Parameters:

foreignSourceName - a String object.

Returns:

a Requisition object.

Throws:

ForeignSourceRepositoryException - if any.

getRequisition

Requisition getRequisition(ForeignSource foreignSource)
                    throws ForeignSourceRepositoryException

getRequisition

Parameters:

foreignSource - a ForeignSource object.

Returns:

a Requisition object.

Throws:

ForeignSourceRepositoryException - if any.

getRequisitionDate

Date getRequisitionDate(String foreignSource)

getRequisitionDate

Parameters:

foreignSource - the Foreign Source name of the requisition.

Returns:

The date-stamp of the requisition, as a Date

getRequisitionURL

URL getRequisitionURL(String foreignSource)

getRequisitionURL

Parameters:

foreignSource - a String object.

Returns:

a URL object.

save

void save(Requisition requisition)
   throws ForeignSourceRepositoryException

save

Parameters:

requisition - a Requisition object.

Throws:

ForeignSourceRepositoryException - if any.

delete

void delete(Requisition requisition)
     throws ForeignSourceRepositoryException

delete

Parameters:

requisition - a Requisition object.

Throws:

ForeignSourceRepositoryException - if any.

getNodeRequisition

OnmsNodeRequisition getNodeRequisition(String foreignSource,
                                       String foreignId)
                                throws ForeignSourceRepositoryException

getNodeRequisition

Parameters:

foreignSource - a String object.

foreignId - a String object.

Returns:

a OnmsNodeRequisition object.

Throws:

ForeignSourceRepositoryException - if any.

validate

void validate(ForeignSource foreignSource)
       throws ForeignSourceRepositoryException

Throws:

ForeignSourceRepositoryException

validate

void validate(Requisition requisition)
       throws ForeignSourceRepositoryException

Throws:

ForeignSourceRepositoryException

flush

void flush()
    throws ForeignSourceRepositoryException

For performance reasons, a get after a save on a ForeignSourceRepository is not guaranteed to return the latest saved data unless you flush first.

Throws:

ForeignSourceRepositoryException

clear

void clear()
    throws ForeignSourceRepositoryException

Delete all requisitions and foreign source definitions and return to defaults.

Throws:

ForeignSourceRepositoryException