Package org.silverpeas.components.jdbcconnector.model

Class DataSourceConnectionInfo

  • All Implemented Interfaces:
    Serializable, org.silverpeas.core.persistence.datasource.model.IdentifiableEntity
    @Entity
public class DataSourceConnectionInfo
extends org.silverpeas.core.persistence.datasource.model.jpa.BasicJpaEntity<DataSourceConnectionInfo,​org.silverpeas.core.persistence.datasource.model.identifier.UniqueIntegerIdentifier>
    Information about a JDBC connection to a data source. Such information is the name of the data source and the credentials required to access that data source.
    Author:
    mmoquillon
    See Also:
    Serialized Form

    • Constructor Detail

      • DataSourceConnectionInfo

        protected DataSourceConnectionInfo()

      • DataSourceConnectionInfo

        public DataSourceConnectionInfo​(String dataSource,
                                String instanceId)

    • Method Detail

      • removeFromComponentInstance

        public static void removeFromComponentInstance​(String instanceId)

      • isDefined

        public boolean isDefined()
        Is this connection information defined? Information about a connection to a data source is defined if both it is related to a ConnecteurJDBC application instance and the name of the data source is defined.
        Returns:

      • withSqlRequest

        public DataSourceConnectionInfo withSqlRequest​(String sqlRequest)
        Sets the SQL request to used when requesting the data source and returns this connection information.
        Parameters:
        sqlRequest - a SQL request.
        Returns:
        itself.

      • withDataMaxNumber

        public DataSourceConnectionInfo withDataMaxNumber​(int maxNumber)
        Sets the maximum number of data to select when requesting the data source and returns this connection information.
        Parameters:
        maxNumber - the maximum number of data to return. 0 means all.
        Returns:
        itself.

      • withDataSourceName

        public DataSourceConnectionInfo withDataSourceName​(String dataSourceName)
        Sets a new data source by its JNDI name to this connection info.
        Parameters:
        dataSourceName - the JNDI name of the data source to connect to.
        Returns:
        itself.

      • getDataSourceName

        public String getDataSourceName()
        Gets the JNDI name of the data source targeted by this connection information.
        Returns:
        the JNDI name of the data source.

      • getInstanceId

        public String getInstanceId()
        Gets the unique identifier of the component instance this connection info belongs to.
        Returns:
        the unique identifier of the component instance.

      • getLogin

        public String getLogin()
        Gets the user identifier used in the data source authentication.
        Returns:
        the login.

      • getPassword

        public String getPassword()
        Gets the password associated with the login to connect the data source.
        Returns:
        the password.

      • getSqlRequest

        public String getSqlRequest()
        Gets the SQL request used to select data from the connected data source.
        Returns:
        the SQL request used in this connection information.

      • getDataMaxNumber

        public int getDataMaxNumber()
        Gets the maximum number of data to return when requesting the data source.
        Returns:
        the maximum number of data to consider. 0 means all.

      • setDataSourceName

        public void setDataSourceName​(String dataSourceName)
        Sets a new data source by its JNDI name to this connection info.
        Parameters:
        dataSourceName - the JNDI name of the data source to connect to.

      • setLoginAndPassword

        public void setLoginAndPassword​(String login,
                                String password)
        Sets the login and the password required to open a connection to the targeted data source.
        Parameters:
        login - a login.
        password - the password associated with the login.

      • setSqlRequest

        public void setSqlRequest​(String sqlRequest)
        Sets the SQL request to used when requesting the data source.
        Parameters:
        sqlRequest - a SQL request.

      • setDataMaxNumber

        public void setDataMaxNumber​(int maxNumber)
        Sets the maximum number of data to select when requesting the data source.
        Parameters:
        maxNumber - the maximum number of data to return. 0 means all.

      • save

        public void save()
        Saves or updates this connection information into the persistence context in order to be able to retrieve it later.

      • remove

        public void remove()
        Removes this connection information from the persistence context.

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class org.silverpeas.core.persistence.datasource.model.jpa.AbstractJpaEntity<DataSourceConnectionInfo,​org.silverpeas.core.persistence.datasource.model.identifier.UniqueIntegerIdentifier>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.silverpeas.core.persistence.datasource.model.jpa.AbstractJpaEntity<DataSourceConnectionInfo,​org.silverpeas.core.persistence.datasource.model.identifier.UniqueIntegerIdentifier>