Skip navigation links

Oracle® Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC)
11g Release 1 (11.1)

E17274-04


oracle.stellent.ridc.convenience.adf.connection
Class RidcConnection

java.lang.Object
  extended by oracle.stellent.ridc.convenience.adf.connection.RidcConnection

All Implemented Interfaces:
Referenceable

public class RidcConnection
extends Object
implements Referenceable

Field Summary
static String CONNECTION_URL_KEY
           
static String IDC_CONNECTION_KEY_PREFIX
           

 

Constructor Summary
RidcConnection()
          Default Constructor.
RidcConnection(Reference ref)
          Constructor that takes in a jndi reference.
RidcConnection(String connectionName, Reference reference)
           

 

Method Summary
static RidcConnection create(Reference ref, Name name, Context nameCtx, Hashtable<?,?> environment)
          Create an an IdcConnection from the given reference using the given name, context and environment properties.
 boolean equals(Object o)
           
 String getAppid(String credentialsLabel, CredentialsType credentialsType)
           
 Map<String,String> getConfigProperties()
          Get the configuration properties of the IDC Connection.
 String getConnectionName()
           
 String getConnectionUrl()
           
static String getFieldNameForAppid(String credentialsLabel, CredentialsType credentialsType)
           
static String getFieldNameForPassword(String credentialsLabel, CredentialsType credentialsType)
           
static String getFieldNameForUserName(String credentialsLabel, CredentialsType credentialsType)
           
 String getPassword(String credentialsLabel, CredentialsType credentialsType)
           
 String getProperty(String name)
          Retrieve a property value by name
 Reference getReference()
          
 int getSocketTimeout()
           
 String getUserName(String credentialsLabel, CredentialsType credentialsType)
           
 int hashCode()
           
 boolean isNewConnection()
          Is this a new connection or an already existing one?
 void setAppid(String credentialsLabel, CredentialsType credentialsType, String appid)
           
 void setConfigParameters(Map<String,String> configParams)
          Set the configuration parameters of the IDC Connection.
 void setConnectionName(String connectionName)
           
 void setConnectionUrl(String connectionUrl)
           
 void setPassword(String credentialsLabel, CredentialsType credentialsType, String password)
           
 void setProperty(String name, String value)
          Set a property name and value
 void setSocketTimeout(int timeout)
           
 void setUserName(String credentialsLabel, CredentialsType credentialsType, String name)
           
 String toString()
          

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

IDC_CONNECTION_KEY_PREFIX

public static final String IDC_CONNECTION_KEY_PREFIX
See Also:
Constant Field Values

CONNECTION_URL_KEY

public static final String CONNECTION_URL_KEY
See Also:
Constant Field Values

Constructor Detail

RidcConnection

public RidcConnection()
Default Constructor.

RidcConnection

public RidcConnection(String connectionName,
                      Reference reference)

RidcConnection

public RidcConnection(Reference ref)
Constructor that takes in a jndi reference. The reference us used to initialize this object's properties.
Parameters:
ref - jndi reference the IdcConnection object will be created from.

Method Detail

create

public static RidcConnection create(Reference ref,
                                    Name name,
                                    Context nameCtx,
                                    Hashtable<?,?> environment)
Create an an IdcConnection from the given reference using the given name, context and environment properties.
Parameters:
ref - a jndi reference object.
name - jndi name.
nameCtx - jndi name context.
environment - environment property hashtable.
Returns:
an IdcConnection representation of the parameters.

getReference

public Reference getReference()
                       throws NamingException
Specified by:
getReference in interface Referenceable
Returns:
Throws:
NamingException

getConnectionName

public String getConnectionName()

setConnectionName

public void setConnectionName(String connectionName)

isNewConnection

public boolean isNewConnection()
Is this a new connection or an already existing one?
Returns:
true if the connection already exists, false otherwise.

setConfigParameters

public void setConfigParameters(Map<String,String> configParams)
Set the configuration parameters of the IDC Connection.
Parameters:
configParams - a map containing configuration properties.

getConfigProperties

public Map<String,String> getConfigProperties()
Get the configuration properties of the IDC Connection.
Returns:
a map containing configuration properties as name value pair.

getProperty

public String getProperty(String name)
Retrieve a property value by name
Parameters:
name - the property name
Returns:
the value

setProperty

public void setProperty(String name,
                        String value)
Set a property name and value
Parameters:
name - the property name
value - the property value

getConnectionUrl

public String getConnectionUrl()

setConnectionUrl

public void setConnectionUrl(String connectionUrl)

getSocketTimeout

public int getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(int timeout)

setUserName

public void setUserName(String credentialsLabel,
                        CredentialsType credentialsType,
                        String name)

getUserName

public String getUserName(String credentialsLabel,
                          CredentialsType credentialsType)

setPassword

public void setPassword(String credentialsLabel,
                        CredentialsType credentialsType,
                        String password)

getPassword

public String getPassword(String credentialsLabel,
                          CredentialsType credentialsType)

setAppid

public void setAppid(String credentialsLabel,
                     CredentialsType credentialsType,
                     String appid)

getAppid

public String getAppid(String credentialsLabel,
                       CredentialsType credentialsType)

getFieldNameForUserName

public static String getFieldNameForUserName(String credentialsLabel,
                                             CredentialsType credentialsType)

getFieldNameForPassword

public static String getFieldNameForPassword(String credentialsLabel,
                                             CredentialsType credentialsType)

getFieldNameForAppid

public static String getFieldNameForAppid(String credentialsLabel,
                                          CredentialsType credentialsType)

toString

public String toString()
Overrides:
toString in class Object
Returns:

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

Skip navigation links

Oracle® Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC)
11g Release 1 (11.1)

E17274-04


Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.