|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.rpe.common.utils.URLDataProvider
public class URLDataProvider
Utility class for accessing remote resources.
Constructor Summary | |
---|---|
URLDataProvider()
WARNING: for use during RRDG Document Generation do NOT create new instances of this object. |
Method Summary | |
---|---|
java.lang.String |
cacheResource(java.lang.String url,
Credential credential)
Returns the path to a cached copy of the resource. |
java.lang.String |
cacheResource(java.lang.String url,
Credential credential,
com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs)
Returns the path to a cached copy of the resource. |
void |
cleanup()
Deletes all cached data. |
static java.io.InputStream |
doNone(java.lang.String url,
com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs)
Downloads the content from the specified URL in the given path with the provided connection arguments |
static java.lang.String |
downloadFile(java.net.URL url)
|
static void |
downloadFile(java.net.URL url,
java.lang.String localPath,
com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs)
Downloads the content from the specified URL in the given path with the provided connection arguments |
java.lang.String |
expandLibraryURL(java.lang.String url)
|
com.ibm.rational.rpe.common.utils.IConnectionConfigurator |
getConnectionConfigurator()
|
java.lang.String |
getLibraryResourceTitle(java.lang.String relativeResourceURL)
|
boolean |
isCached(java.lang.String url)
Returns true if the url is already cached locally |
java.io.InputStream |
openDataStream(java.lang.String url,
Credential credential)
Returns a stream to the desired resource with no caching. |
java.io.InputStream |
openDataStream(java.lang.String url,
Credential credential,
com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs)
Returns a stream to the desired resource with no caching. |
void |
registerFile(java.lang.String file)
|
void |
setConnectionConfigurator(com.ibm.rational.rpe.common.utils.IConnectionConfigurator connectionConfigurator)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public URLDataProvider()
Method Detail |
---|
public void setConnectionConfigurator(com.ibm.rational.rpe.common.utils.IConnectionConfigurator connectionConfigurator)
public com.ibm.rational.rpe.common.utils.IConnectionConfigurator getConnectionConfigurator()
public boolean isCached(java.lang.String url) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public java.lang.String cacheResource(java.lang.String url, Credential credential, com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
url
- - cannot be emptycredential
- - cannot be nullacceptHeader
- - the accept header to use
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public java.lang.String cacheResource(java.lang.String url, Credential credential) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
url
- - cannot be emptycredential
- - cannot be null
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public java.io.InputStream openDataStream(java.lang.String url, Credential credential) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
url
- - cannot be emptycredential
- - cannot be null
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public java.io.InputStream openDataStream(java.lang.String url, Credential credential, com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
url
- - cannot be emptycredential
- - cannot be nullacceptHeader
- - the accept header to use
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public static java.io.InputStream doNone(java.lang.String url, com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
url
- - cannot be NULLlocalPath
- - cannot be NULLconnectionArgs
- - cannot be NULL
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public void cleanup()
public static java.lang.String downloadFile(java.net.URL url) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public static void downloadFile(java.net.URL url, java.lang.String localPath, com.ibm.rational.rpe.common.utils.ConnectionArguments connectionArgs) throws com.ibm.rational.rpe.common.auth.AuthenticationException, com.ibm.rational.rpe.common.utils.conn.ConnectionException
url
- - cannot be NULLlocalPath
- - cannot be NULLconnectionArgs
- - cannot be NULL
com.ibm.rational.rpe.common.auth.AuthenticationException
com.ibm.rational.rpe.common.utils.conn.ConnectionException
public void registerFile(java.lang.String file)
public java.lang.String expandLibraryURL(java.lang.String url)
public java.lang.String getLibraryResourceTitle(java.lang.String relativeResourceURL) throws java.io.IOException, com.ibm.rational.rpe.common.auth.AuthenticationException
java.io.IOException
com.ibm.rational.rpe.common.auth.AuthenticationException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |