Developing a simple Add-on

[mylos78]

Hi all,

I'd like to develop a basic add-on which will let me customize my web application web.xml by including automatically security constraints, taken from user input. So far I've found an example which adds libraries to your pom.xml through the DependencyInstaller and DependencyResolver.

public class HelloWorldUICommand extends AbstractProjectCommand {
    
    @Inject ProjectFactory projectFactory;

    @Inject @WithAttributes(label = "Name", required = true, description = "Enter your name")  
    UIInput<String> input;
    
    @Inject DependencyInstaller dependencyInstaller;

    @Inject DependencyResolver dependencyResolver;    
    
    @Inject @WithAttributes(label = "Version", required = true, description = "Select the version of PicketLink") 
    private UISelectOne<Coordinate> version;    
    
    @Override
    public void initializeUI(UIBuilder builder) throws Exception {
        builder.add(input);
        
        DependencyQuery query = DependencyQueryBuilder
                .create("org.picketlink:picketlink-api")
                .setFilter(new NonSnapshotDependencyFilter());

        List<Coordinate> coordinates = dependencyResolver.resolveVersions(query);
        version.setValueChoices(coordinates);
        builder.add(version);        
    }

    @Override
    public Result execute(UIExecutionContext context) throws Exception {
        DependencyBuilder builder = DependencyBuilder.create();
        builder.setCoordinate(version.getValue());

        dependencyInstaller.install(getSelectedProject(context), builder);
        
        return Results.success("Hello World");
    }

    @Override
    protected boolean isProjectRequired() {
        return true;
    }

    @Override
    protected ProjectFactory getProjectFactory() {
        return projectFactory;
    }
}

I wonder if there is also a specific class to modify a web project's XML files, or any other way to customize it from the add-on.

Many thanks

Mylos

[gastaldi]

Hi Mylos,

Yes, you can use the ServletFacet's methods or call getConfig() from the same facet to retrieve a WebAppDescriptor instance.

Here is a command example that adds security constraints to a web.xml: core/AddSecurityConstraintCommand.java at master · forge/core · GitHub

Let me know if you need anything else.

Best Regards,

George Gastaldi

[mylos78]

Thank you very much for the reply George.

I'll try it right away.

May I ask one more thing ? is there any Forge Helper class which gives me the physical path where the WebContent is so that I can modify XML files manually ? this would be helpful in case I want to modify also non-standard XML project files (jboss-deployment-structure.xml) or even my application XML files.

Thanks a lot!

[gastaldi]

Yes, the same ServletFacet has a getConfigFile() method that returns a FileResource (you can call getContents/setContents there) or if you need the java.io.File you can call the getUnderlyingResourceObject() in the FileResource object.

[mylos78]

awesome, thanks!