Month: January 2018

Python clean up old files

leaf

Was learning Python and wrote this script to clean up files.  It’s not awesome.  Has no error handling for when the target file is already open.  Just kinda barfs when that happens.  So it needs work.  This was written in Python 3.

#This script uses a library called path.py.  Get it from here: https://pypi.python.org/pypi/path.py
#Download the Python Wheel file.  At this writing, it is called path.py-8.2.1-py2.py3-none-any.whl.  
#Install using the command: pip install <name of wheel file>.
#You must have Python installed first.  Been a while since I installed it, but here is the official place to 
#get it from: https://www.python.org/downloads/
#Once you have everything installed and the script works, use Windows Task Scheduler to run it, so you don't forget.

import timefrom 
path import path

def main():  
  # Because in python, the \ is an escape character, we need to use two of them in directory specifications  
  paths = ["c:\\jboss\\jboss-eap-5.1\\jboss-as\\server\\default\\tmp","c:\\jboss\\jboss-eap-5.1\\jboss-as\\server\\default\\log"]  
  DAYS = 7  
  time_in_seconds = time.time() - (DAYS * 24 * 60 * 60)  
  removed = 0  
  for p in paths:    
    print (p)    
    d = path(p)      

    for f in d.walk():      
      if f.mtime <= time_in_seconds:        
        print ("Deleting " + f.basename())        
        f.remove()        
        removed += 1     
  print ("Removed " + str(removed) + " files.")
if __name__ == "__main__":  
  main()
Advertisements

SQL Tidbits

creek (2)

Handy little bits.  Have long-since forgotten where I got these little gems from.

Find a constraint by name

Select SysObjects.[Name] As [Constraint Name] ,
 Tab.[Name] as [Table Name],
 Col.[Name] As [Column Name]
From SysObjects Inner Join 
(Select [Name],[ID] From SysObjects) As Tab
On Tab.[ID] = Sysobjects.[Parent_Obj] 
Inner Join sysconstraints On sysconstraints.Constid = Sysobjects.[ID] 
Inner Join SysColumns Col On Col.[ColID] = sysconstraints.[ColID] And Col.[ID] = Tab.[ID]
where sysobjects.name = 'constraint name'
order by [Tab].[Name]

Find foreign-key related tables

SELECT f.name AS ForeignKey,
SCHEMA_NAME(f.SCHEMA_ID) SchemaName,
OBJECT_NAME(f.parent_object_id) AS TableName,
COL_NAME(fc.parent_object_id,fc.parent_column_id) AS ColumnName,
SCHEMA_NAME(o.SCHEMA_ID) ReferenceSchemaName,
OBJECT_NAME (f.referenced_object_id) AS ReferenceTableName,
COL_NAME(fc.referenced_object_id,fc.referenced_column_id) AS ReferenceColumnName
FROM sys.foreign_keys AS f
INNER JOIN sys.foreign_key_columns AS fc ON f.OBJECT_ID = fc.constraint_object_id
INNER JOIN sys.objects AS o ON o.OBJECT_ID = fc.referenced_object_id
where OBJECT_NAME(f.referenced_object_id) = 'table name'
order by TableName, columnname

 

Shrink log files

Use master
declare @dbName varchar(100)
declare @recoveryModel varchar(100)
declare @sqlString varchar(100)
declare @dbId integer
declare @logFileName varchar(100)
declare dbcursor cursor for select name, recovery_model_desc from sys.databases where recovery_model_desc != 'SIMPLE'
open dbcursor
while 1=1
begin 
fetch from dbcursor into @dbName, @recoveryModel 
if @@FETCH_STATUS != 0 break 
print @recoveryModel + ' ' + @dbname + ' setting recovery model to SIMPLE.' 
SET @sqlString = 'ALTER DATABASE [' + @dbname + '] SET RECOVERY SIMPLE' 
EXECUTE (@sqlString) 
end
close dbcursor
deallocate dbcursor 

declare dbcursor2 cursor for 
select name, recovery_model_desc, database_id from sys.databases 
where recovery_model_desc = 'SIMPLE'
open dbcursor2
while 1=1
begin 
fetch from dbcursor2 into @dbName, @recoveryModel, @dbId 
if @@FETCH_STATUS != 0 break
 set @logFileName = (select name from sys.master_files where database_id = @dbId and type = 1) 
print 'Shrinking log file ' + @logFileName + ' for database ' + @dbName 
set @sqlString = 'USE ' + @dbName + '; ' + 'DBCC SHRINKFILE (' + @logFileName + ')' 
execute (@sqlString)
end
close dbcursor2
deallocate dbcursor2

RESTEasy Swagger Maven Cheat Sheet

dragonFly3

Settings.xml file

  • <deploy.env> This parameter is used for many things that have nothing to do with the RESTful API, but it also plays a role in the RESTful API.  It is used to create the URLs that allow us to access Swagger for the documentation and testing of the API.

In the pom.xml file, in the generate-service-docs execution, the additional parameters docBasePath and apiBasePath rely on both the resteasy.service.host and deploy.env parameters to construct URLs used by Swagger.

RESTeasy entries in web.xml file

https://docs.jboss.org/resteasy/docs/1.0.1.GA/userguide/html/Installation_Configuration.html

<listener>

This entry identifies the RESTeasy class that will initialize RESTeasy.

<listener>
<listener-class>org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap</listener-class>
</listener>

<servlet>

This entry identifies our class that extends the javax.ws.rs.Application class.  The RestApp identifies the RESTful beans, and some other classes that are used in packaging REST responses, formatting JSON, etc.

<servlet>
<servlet-name>Resteasy</servlet-name>
<servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</servlet-class>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>com.ep.ff.web.endpoint.RestApp</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>

 

<servlet-mapping>
<servlet-name>Resteasy</servlet-name>
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>

<context-param>

Various parameters that control aspects of RESTeasy.  For each the parameter name and value are specified.

<context-param>
<param-name>resteasy.servlet.mapping.prefix</param-name>
<param-value>/rest</param-value>
</context-param>

<context-param>
<param-name>resteasy.jndi.resources</param-name>
<param-value>earname/beanname/local
</param-value>
</context-param>

<context-param>
<param-name>resteasy.role.based.security</param-name>
<param-value>true</param-value>
</context-param>

<security-constraint>

<security-constraint>
<web-resource-collection>
<web-resource-name>REST Resources</web-resource-name>
<url-pattern>/swagger/*</url-pattern>
<url-pattern>/apidocs/*</url-pattern>
<url-pattern>/rest/*</url-pattern>
<http-method>GET</http-method>
<http-method>POST</http-method>
<http-method>PUT</http-method>
<http-method>DELETE</http-method>
<http-method>TRACE</http-method>
</web-resource-collection>

<auth-constraint>
<role-name>rolename</role-name>
</auth-constraint>
</security-constraint>

RESTeasy entries in pom files

web

<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jaxrs</artifactId>
<version>3.0.7.Final</version>
</dependency>

<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jackson-provider</artifactId>
<version>3.0.7.Final</version>
</dependency>

web-ejb

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<executions>
<execution>
<id>generate-service-docs</id>
<phase>generate-resources</phase>
<configuration>
<doclet>com.carma.swagger.doclet.ServiceDoclet</doclet>
<docletArtifact>
<groupId>com.carma</groupId>
<artifactId>swagger-doclet</artifactId>
<version>1.0.4.1</version>
</docletArtifact>
<reportOutputDirectory>output directory</reportOutputDirectory>
<useStandardDocletOptions>false</useStandardDocletOptions>
<additionalparam>-apiVersion 1 -docBasePath path/apidocs -apiBasePath path/rest</additionalparam>
</configuration>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>

The -apiBasePath is used to resolve the URLs to the services for testing the methods via Swagger.  If the {resteasy.service.host} parameter is not supplied, either in the settings.xml file or on the maven command line, you will not be able to click into the links in Swagger to be able to see the documented API or test the services.

Steps to RESTful-ize an existing bean

  • WEB-INF\web.xml needs the web bean added to the resteasy.jndi.resources <context-param> tag in the <param-value> tag.  Follow the same pattern as the existing web beans. Comma delimit.
  • In RestApp.java, add the web bean in the setClasses() method.
  • In the web bean class itself, fix the @EJB annotations to include the name argument.
  • In the web interface class, add class-level and method-level REST annotations.
    • @GET, @POST, @DELETE, @PUT (usually @GET or @POST)
    • @Path(path name).  Take the method name, and change it to be all lower-case, hyphenated, and use that for the path name.
    • @Produces(MediaType.APPLICATION_JSON), @Consumes(MediaType.APPLICATION-JSON)
  • If the method does not have a @RolesAllowed tag, it must be added and tested.  Otherwise anyone will be able to access the method just by knowing the URL.
  • Handle cyclic references with a @JsonIgnore tag, to prevent StackOverflowError.

 

Swagger

Swagger is a tool that helps to document and test a RESTful API.

https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-RESTEasy-2.X-Project-Setup-1.5

Java Classes

RestApp

CustomJacksonJsonProvider

Allows for customization of the methods used to read and write JSON strings.

JsonMappingExceptionMapper

Creates an exception for errors related to Json mapping.

RestResponseInterceptor