org.zaproxy.zap.extension.api

Class WikiAPIGenerator

java.lang.Object

org.zaproxy.zap.extension.api.WikiAPIGenerator

public class WikiAPIGenerator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACTION_ENDPOINT
protected static String	OPTIONAL_MESSAGE
protected static String	OTHER_ENDPOINT
protected static String	VIEW_ENDPOINT

Constructor Summary

Constructors

Constructor and Description
WikiAPIGenerator()
WikiAPIGenerator(String path, boolean optional)

Method Summary

Modifier and Type	Method and Description
protected void	generateAPIFiles(ApiImplementor imp) Generates the API client files of the given API implementor.
void	generateAPIFiles(List<ApiImplementor> implementors) Generates the wiki files of the given API implementors.
void	generateCoreAPIFiles() Generates the API client files for the core API implementors.
void	generateWikiFiles(List<ApiImplementor> implementors) Deprecated. (2.6.0) Use generateAPIFiles(List) instead.
protected Path	getDirectory() Gets the directory where the API client files should be generated.
protected ResourceBundle	getMessages() Gets the messages for doc of the generated classes.
protected boolean	isOptional() If the API client files being generated are optional, that is, belong to an add-on.
static void	main(String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTIONAL_MESSAGE

protected static final String OPTIONAL_MESSAGE

See Also:

Constant Field Values

VIEW_ENDPOINT

protected static final String VIEW_ENDPOINT

See Also:

Constant Field Values

ACTION_ENDPOINT

protected static final String ACTION_ENDPOINT

See Also:

Constant Field Values

OTHER_ENDPOINT

protected static final String OTHER_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

WikiAPIGenerator

public WikiAPIGenerator()

WikiAPIGenerator

public WikiAPIGenerator(String path,
                        boolean optional)

Method Detail

generateWikiFiles

@Deprecated
public void generateWikiFiles(List<ApiImplementor> implementors)
                                   throws IOException

Deprecated. (2.6.0) Use generateAPIFiles(List) instead.

Generates the wiki files of the given API implementors.

Parameters:

implementors - the implementors

Throws:

IOException - if an error occurred while generating the APIs.

generateAPIFiles

public void generateAPIFiles(List<ApiImplementor> implementors)
                      throws IOException

Generates the wiki files of the given API implementors.

Parameters:

implementors - the API implementors, must not be null

Throws:

IOException - if an error occurred while writing the API files

generateAPIFiles

protected void generateAPIFiles(ApiImplementor imp)
                         throws IOException

Generates the API client files of the given API implementor.

Parameters:

imp - the API implementor, must not be null

Throws:

IOException - if an error occurred while writing the API files

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

getDirectory

protected Path getDirectory()

Gets the directory where the API client files should be generated.

Returns:

the directory where the API client files should be generated

isOptional

protected boolean isOptional()

If the API client files being generated are optional, that is, belong to an add-on.

Returns:

true if the API client files are optional, false otherwise

getMessages

protected ResourceBundle getMessages()

Gets the messages for doc of the generated classes.

Returns:

the ResourceBundle with the messages for doc

generateCoreAPIFiles

public void generateCoreAPIFiles()
                          throws IOException

Generates the API client files for the core API implementors.

Throws:

IOException - if an error occurred while writing the API files