Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.sql.execute.JarUtil

Modifier and Type	Field and Description
private DataDictionary	dd
private DataDescriptorGenerator	ddg
private FileResource	fr
private LanguageConnectionContext	lcc
private String	schemaName
private String	sqlName

Access	Constructor and Description
private	JarUtil(LanguageConnectionContext lcc, String schemaName, String sqlName)

Method Summary

Modifier and Type	Method and Description
private long	add(final InputStream A stream for reading the content of the file to add. is) Add a jar file to the current connection's database.
public static void	drop(LanguageConnectionContext lcc, String the name for the schema that holds the jar file. schemaName, String the sql name for the jar file. sqlName) Drop a jar file from the current connection's database.
private void	drop() Drop a jar file from the current connection's database.
private static Context	getContextOrNull(final String contextID) Must be private so that user code can't call this entry point.
private FileInfoDescriptor	getInfo() Get the FileInfoDescriptor for the Jar file or null if it does not exist.
public static long	Returns: The generationId for the jar file we add. install(LanguageConnectionContext lcc, String the name for the schema that holds the jar file. schemaName, String the sql name for the jar file. sqlName, String the path for the jar file to add. externalPath) install a jar file to the current connection's database.
public static String	mkExternalName(UUID id, String schemaName, String sqlName, char separatorChar) Make an external name for a jar file stored in the database.
private static String	mkExternalNameInternal(UUID id, String schemaName, String sqlName, char separatorChar, boolean upgrading, boolean newStyle)
private void	notifyLoader(boolean reload)
private static InputStream	openJarURL(final String externalPath) Open an input stream to read a URL or a file.
public static long	Returns: The new generationId for the jar file we replace. replace(LanguageConnectionContext lcc, String the name for the schema that holds the jar file. schemaName, String the sql name for the jar file. sqlName, String the path for the jar file to add. externalPath) Replace a jar file from the current connection's database with the content of an external file.
private long	replace(InputStream An input stream for reading the new content of the jar file. is) Replace a jar file in the current connection's database with the content of an external file.
private long	setJar(final String Name of jar with database structure. jarExternalName, final InputStream Contents of jar file. contents, final boolean true to add, false to replace add, final long generation id of existing version, ignored when adding. currentGenerationId) Copy the jar from the externally obtained input stream into the database
public static void	upgradeJar(TransactionController transaction controller tc, FileInfoDescriptor the jar file to be upgraded fid) Upgrade code: upgrade one jar file to new style (>= 10.9)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

dd	back to summary
private DataDictionary dd

ddg	back to summary
private DataDescriptorGenerator ddg

fr	back to summary
private FileResource fr

lcc	back to summary
private LanguageConnectionContext lcc

schemaName	back to summary
private String schemaName

sqlName	back to summary
private String sqlName

JarUtil	back to summary
private JarUtil(LanguageConnectionContext lcc, String schemaName, String sqlName) throws StandardException

Method Detail

add	back to summary
private long add(final InputStream is) throws StandardException Add a jar file to the current connection's database. The reason for adding the jar file in this private instance method is that it allows us to share set up logic with drop and replace. Parameters is:InputStream A stream for reading the content of the file to add. Exceptions StandardException: Opps

add

back to summary

private long add(final InputStream is) throws StandardException

Add a jar file to the current connection's database.

The reason for adding the jar file in this private instance method is that it allows us to share set up logic with drop and replace.

Parameters

is:InputStream: A stream for reading the content of the file to add.

Exceptions

StandardException:: Opps

drop	back to summary
public static void drop(LanguageConnectionContext lcc, String schemaName, String sqlName) throws StandardException Drop a jar file from the current connection's database. Parameters schemaName:String the name for the schema that holds the jar file. sqlName:String the sql name for the jar file. Exceptions StandardException: Opps

drop

back to summary

public static void drop(LanguageConnectionContext lcc, String schemaName, String sqlName) throws StandardException

Drop a jar file from the current connection's database.

Parameters

schemaName:String: the name for the schema that holds the jar file.
sqlName:String: the sql name for the jar file.

Exceptions

StandardException:: Opps

drop	back to summary
private void drop() throws StandardException Drop a jar file from the current connection's database. The reason for dropping the jar file in this private instance method is that it allows us to share set up logic with add and replace. Exceptions StandardException: Opps

drop

back to summary

private void drop() throws StandardException

Drop a jar file from the current connection's database.

The reason for dropping the jar file in this private instance method is that it allows us to share set up logic with add and replace.

Exceptions

StandardException:: Opps

getContextOrNull	back to summary
private static Context getContextOrNull(final String contextID) Must be private so that user code can't call this entry point.

getInfo	back to summary
private FileInfoDescriptor getInfo() throws StandardException Get the FileInfoDescriptor for the Jar file or null if it does not exist. Exceptions StandardException: Ooops

getInfo

back to summary

private FileInfoDescriptor getInfo() throws StandardException

Get the FileInfoDescriptor for the Jar file or null if it does not exist.

Exceptions

StandardException:: Ooops

install	back to summary
public static long install(LanguageConnectionContext lcc, String schemaName, String sqlName, String externalPath) throws StandardException install a jar file to the current connection's database. Parameters schemaName:String the name for the schema that holds the jar file. sqlName:String the sql name for the jar file. externalPath:String the path for the jar file to add. Returns:long The generationId for the jar file we add. Exceptions StandardException: Opps

install

back to summary

public static long install(LanguageConnectionContext lcc, String schemaName, String sqlName, String externalPath) throws StandardException

install a jar file to the current connection's database.

Parameters

schemaName:String: the name for the schema that holds the jar file.
sqlName:String: the sql name for the jar file.
externalPath:String: the path for the jar file to add.

Returns:long

The generationId for the jar file we add.

Exceptions

StandardException:: Opps

mkExternalName	back to summary
public static String mkExternalName(UUID id, String schemaName, String sqlName, char separatorChar) throws StandardException Make an external name for a jar file stored in the database.

mkExternalNameInternal	back to summary
private static String mkExternalNameInternal(UUID id, String schemaName, String sqlName, char separatorChar, boolean upgrading, boolean newStyle) throws StandardException

notifyLoader	back to summary
private void notifyLoader(boolean reload) throws StandardException

openJarURL	back to summary
private static InputStream openJarURL(final String externalPath) throws IOException Open an input stream to read a URL or a file. URL is attempted first, if the string does not conform to a URL then an attempt to open it as a regular file is tried. Attempting the file first can throw a security execption when a valid URL is passed in. The security exception is due to not have the correct permissions to access the bogus file path. To avoid this the order was reversed to attempt the URL first and only attempt a file open if creating the URL throws a MalformedURLException.

openJarURL

back to summary

private static InputStream openJarURL(final String externalPath) throws IOException

Open an input stream to read a URL or a file. URL is attempted first, if the string does not conform to a URL then an attempt to open it as a regular file is tried.
Attempting the file first can throw a security execption when a valid URL is passed in. The security exception is due to not have the correct permissions to access the bogus file path. To avoid this the order was reversed to attempt the URL first and only attempt a file open if creating the URL throws a MalformedURLException.

replace	back to summary
public static long replace(LanguageConnectionContext lcc, String schemaName, String sqlName, String externalPath) throws StandardException Replace a jar file from the current connection's database with the content of an external file. Parameters schemaName:String the name for the schema that holds the jar file. sqlName:String the sql name for the jar file. externalPath:String the path for the jar file to add. Returns:long The new generationId for the jar file we replace. Exceptions StandardException: Opps

replace

back to summary

public static long replace(LanguageConnectionContext lcc, String schemaName, String sqlName, String externalPath) throws StandardException

Replace a jar file from the current connection's database with the content of an external file.

Parameters

schemaName:String: the name for the schema that holds the jar file.
sqlName:String: the sql name for the jar file.
externalPath:String: the path for the jar file to add.

Returns:long

The new generationId for the jar file we replace.

Exceptions

StandardException:: Opps

replace	back to summary
private long replace(InputStream is) throws StandardException Replace a jar file in the current connection's database with the content of an external file. The reason for adding the jar file in this private instance method is that it allows us to share set up logic with add and drop. Parameters is:InputStream An input stream for reading the new content of the jar file. Exceptions StandardException: Opps

replace

back to summary

private long replace(InputStream is) throws StandardException

Replace a jar file in the current connection's database with the content of an external file.

The reason for adding the jar file in this private instance method is that it allows us to share set up logic with add and drop.

Parameters

is:InputStream: An input stream for reading the new content of the jar file.

Exceptions

StandardException:: Opps

setJar	back to summary
private long setJar(final String jarExternalName, final InputStream contents, final boolean add, final long currentGenerationId) throws StandardException Copy the jar from the externally obtained input stream into the database Parameters jarExternalName:String Name of jar with database structure. contents:InputStream Contents of jar file. add:boolean true to add, false to replace currentGenerationId:long generation id of existing version, ignored when adding.

setJar

back to summary

private long setJar(final String jarExternalName, final InputStream contents, final boolean add, final long currentGenerationId) throws StandardException

Copy the jar from the externally obtained input stream into the database

Parameters

jarExternalName:String: Name of jar with database structure.
contents:InputStream: Contents of jar file.
add:boolean: true to add, false to replace
currentGenerationId:long: generation id of existing version, ignored when adding.

upgradeJar	back to summary
public static void upgradeJar(TransactionController tc, FileInfoDescriptor fid) throws StandardException Upgrade code: upgrade one jar file to new style (>= 10.9) Parameters tc:TransactionController transaction controller fid:FileInfoDescriptor the jar file to be upgraded

upgradeJar

back to summary

public static void upgradeJar(TransactionController tc, FileInfoDescriptor fid) throws StandardException

Upgrade code: upgrade one jar file to new style (>= 10.9)

Parameters

tc:TransactionController: transaction controller
fid:FileInfoDescriptor: the jar file to be upgraded

public Class JarUtil

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail