Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

oracle.javatools.db.ora
Class DatabaseLink

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractBuildableObject
          extended by oracle.javatools.db.AbstractSystemObject
              extended by oracle.javatools.db.AbstractSchemaObject
                  extended by oracle.javatools.db.ora.DatabaseLink
All Implemented Interfaces:
DBObject, SchemaObject, SystemObject, Copyable, DynamicPropertySet

public class DatabaseLink
extends AbstractSchemaObject

Model of a database DatabaseLink. A DatabaseLink is a reference to another database.


Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject
AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport
 
Field Summary
static java.lang.String PUBLIC_TYPE
           
static java.lang.String TYPE
           
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
DatabaseLink()
          Construct a new DatabaseLink
DatabaseLink(java.lang.String name, Schema schema, DBObjectID id)
          Construct a new DatabaseLink .
 
Method Summary
 java.lang.String getAuthentificationPassword()
          Retrieves the password for the authentification user.
 java.lang.String getAuthentificationPasswordX()
          Retrieves the encrypted password for the authentification user.
 java.lang.String getAuthentificationUser()
          Deprecated. 
 java.lang.String getAuthentificationUsername()
          Retrieves the user name for authentificating shared links
 java.lang.Boolean getConnectToUser()
          Whether this database link is connected via the connected user, the current user or a fixed user.
 java.lang.String getCreated()
          Retrieves the dblink creation date.
 DBObjectProvider getDBLink()
          Deprecated. with no replacement.
 java.lang.String getHost()
          Retrieves the SQL*Net string for connect.
 java.lang.String getPassword()
          Retrieves the password for the user.
 java.lang.String getPasswordX()
          Retrieves the encrypted password for the user.
 java.lang.String getType()
          Returns the type of this object.
 java.lang.String getUsername()
          Retrieves the user name for the connention
 boolean isCurrentUser()
          Deprecated. use getConnectToUser()instead.
 boolean isPublic()
          Whether this database link is public.
 boolean isShared()
          Whether this database link is shared.
 void setAuthentificationPassword(java.lang.String authentificationPassword)
          Set the password for the authentification user
 void setAuthentificationPasswordX(java.lang.String encryptedPassword)
          Set the encrypted password for the authentification user.
 void setAuthentificationUsername(java.lang.String authentificationUsername)
          Set the user name for authentificating shared links
 void setConnectToUser(java.lang.Boolean connectToUser)
          Sets how this database link is connected.
 void setCreated(java.lang.String created)
          Set the dblink creation date
 void setCurrentUser(boolean currentUser)
          Deprecated. use setConnectToUser(Boolean)instead.
 void setHost(java.lang.String host)
          Set the SQL*Net string for connect.
 void setPassword(java.lang.String password)
          Set the password for the connention
 void setPasswordX(java.lang.String encryptedPassword)
          Set the encrypted password for the connention
 void setPublic(boolean pub)
          Sets whether this database link is public.
 void setShared(boolean shared)
          Sets whether this database link is shared.
 void setUsername(java.lang.String username)
          Set the user name for the connention
 
Methods inherited from class oracle.javatools.db.AbstractSchemaObject
copyToImpl, equalsImpl, getProperty, getSchema, setProperty, setSchema
 
Methods inherited from class oracle.javatools.db.AbstractSystemObject
addObjectListener, addObjectListener, addObjectListener, fireObjectUpdated, getParent, removeObjectListener, removeObjectListener, removeObjectListener
 
Methods inherited from class oracle.javatools.db.AbstractBuildableObject
checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization
 
Methods inherited from class oracle.javatools.db.AbstractDBObject
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.javatools.db.SchemaObject
addObjectListener, removeObjectListener
 
Methods inherited from interface oracle.javatools.db.SystemObject
addObjectListener, addObjectListener, fireObjectUpdated, removeObjectListener, removeObjectListener
 
Methods inherited from interface oracle.javatools.db.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getReferenceIDs, replaceReferenceIDs, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperties, getProperty, setProperties
 

Field Detail

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values

PUBLIC_TYPE

public static final java.lang.String PUBLIC_TYPE
See Also:
Constant Field Values
Constructor Detail

DatabaseLink

public DatabaseLink()
Construct a new DatabaseLink


DatabaseLink

public DatabaseLink(java.lang.String name,
                    Schema schema,
                    DBObjectID id)
Construct a new DatabaseLink .

Parameters:
name - the name of the new DatabaseLink
schema - the schema containing the DatabaseLink
id - the id of this object.
Method Detail

getType

public java.lang.String getType()
Description copied from interface: DBObject
Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:
a string describing the type of object.

isPublic

public boolean isPublic()
Whether this database link is public.

Returns:
a boolean value indicating whether this schema is public

setPublic

public void setPublic(boolean pub)
Sets whether this database link is public.

Parameters:
pub - a boolean value indicating whether this schema is public

isShared

public boolean isShared()
Whether this database link is shared.

Returns:
a boolean value indicating whether this schema is shared

setShared

public void setShared(boolean shared)
Sets whether this database link is shared.

Parameters:
shared - a boolean value indicating whether this schema is shared

isCurrentUser

@Deprecated
public boolean isCurrentUser()
Deprecated. use getConnectToUser()instead.


setCurrentUser

@Deprecated
public void setCurrentUser(boolean currentUser)
Deprecated. use setConnectToUser(Boolean)instead.


getConnectToUser

public java.lang.Boolean getConnectToUser()
Whether this database link is connected via the connected user, the current user or a fixed user.

Returns:
a Boolean value indicating whether this schema is connected via the current user.

setConnectToUser

public void setConnectToUser(java.lang.Boolean connectToUser)
Sets how this database link is connected.

Parameters:
connectToUser - a boolean value indicating whether this schema is connected via the current user.

getUsername

public java.lang.String getUsername()
Retrieves the user name for the connention


setUsername

public void setUsername(java.lang.String username)
Set the user name for the connention


getPassword

public java.lang.String getPassword()
Retrieves the password for the user.


setPassword

public void setPassword(java.lang.String password)
Set the password for the connention


getPasswordX

public java.lang.String getPasswordX()
Retrieves the encrypted password for the user.


setPasswordX

public void setPasswordX(java.lang.String encryptedPassword)
Set the encrypted password for the connention


getHost

public java.lang.String getHost()
Retrieves the SQL*Net string for connect.


setHost

public void setHost(java.lang.String host)
Set the SQL*Net string for connect.


getCreated

public java.lang.String getCreated()
Retrieves the dblink creation date.


setCreated

public void setCreated(java.lang.String created)
Set the dblink creation date


getDBLink

@Deprecated
public DBObjectProvider getDBLink()
Deprecated. with no replacement.


getAuthentificationUser

@Deprecated
public java.lang.String getAuthentificationUser()
Deprecated. 


getAuthentificationUsername

public java.lang.String getAuthentificationUsername()
Retrieves the user name for authentificating shared links


setAuthentificationUsername

public void setAuthentificationUsername(java.lang.String authentificationUsername)
Set the user name for authentificating shared links


getAuthentificationPassword

public java.lang.String getAuthentificationPassword()
Retrieves the password for the authentification user.


setAuthentificationPassword

public void setAuthentificationPassword(java.lang.String authentificationPassword)
Set the password for the authentification user


getAuthentificationPasswordX

public java.lang.String getAuthentificationPasswordX()
Retrieves the encrypted password for the authentification user.


setAuthentificationPasswordX

public void setAuthentificationPasswordX(java.lang.String encryptedPassword)
Set the encrypted password for the authentification user.


Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

Copyright © 1997, 2011, Oracle. All rights reserved.