project

Documentation

Index

• Constants
• Variables
• func GetGroupId() (string, error)
• func IsSupportedJavaVersion(javaVersion int) bool
• type Metadata
  • func NewMetadata(base, version, edition string) (*Metadata, error)
• type Pom
• type ProductInfo
• type WorkspacePom

Constants

const (
	Gradle = "gradle"
	Maven  = "maven"
	DXP    = "dxp"
	Portal = "portal"
)

Build & Edition options

const (
	XMLHeader = `<?xml version="1.0"?>` + "\n"
)

XMLHeader is the first line to be written in an XML file

Variables

var PackageName string

Package name to use for the project, default is org.acme

Functions

func GetGroupId

func GetGroupId() (string, error)

Get the group ID (base package name) associated with the Liferay workspace

func IsSupportedJavaVersion

func IsSupportedJavaVersion(javaVersion int) bool

Checks if the Java version is supported by Liferay

Types

type Metadata

type Metadata struct {
	Product        string
	BundleUrl      string
	TomcatVersion  string
	TargetPlatform string
	DockerImage    string
	GroupId        string
	ArtifactId     string
	Name           string
}

Metadata represents the basic informations associated with a Liferay project

func NewMetadata

func NewMetadata(base, version, edition string) (*Metadata, error)

Returns metadata for a given project and the chosen Liferay version

type Pom

type Pom struct {
	XMLName        xml.Name `xml:"project"`
	Xmlns          string   `xml:"xmlns,attr"`
	Xsi            string   `xml:"xmlns:xsi,attr"`
	SchemaLocation string   `xml:"xmlns:schemaLocation,attr"`
	ModelVersion   string   `xml:"modelVersion"`
	Parent         struct {
		GroupId      string `xml:"groupId"`
		ArtifactId   string `xml:"artifactId"`
		Version      string `xml:"version"`
		RelativePath string `xml:"relativePath"`
	} `xml:"parent"`
	GroupId    string `xml:"groupId"`
	ArtifactId string `xml:"artifactId"`
	Name       string `xml:"name"`
	Packaging  string `xml:"packaging"`
	Modules    struct {
		Module []string `xml:"module"`
	} `xml:"modules"`
}

Pom represents the common structure of a Maven pom file

type ProductInfo

type ProductInfo struct {
	AppServerTomcatVersion string `json:"appServerTomcatVersion"`
	BundleURL              string `json:"bundleUrl"`
	BundleChecksumMD5      string `json:"bundleChecksumMD5"`
	BundleChecksumMD5URL   string `json:"bundleChecksumMD5Url"`
	LiferayDockerImage     string `json:"liferayDockerImage"`
	LiferayProductVersion  string `json:"liferayProductVersion"`
	Promoted               string `json:"promoted"`
	ReleaseDate            string `json:"releaseDate"`
	TargetPlatformVersion  string `json:"targetPlatformVersion"`
	Name                   string `json:"name"`
}

type WorkspacePom

type WorkspacePom struct {
	XMLName        xml.Name `xml:"project"`
	Xmlns          string   `xml:"xmlns,attr"`
	Xsi            string   `xml:"xmlns:xsi,attr"`
	SchemaLocation string   `xml:"xmlns:schemaLocation,attr"`
	ModelVersion   string   `xml:"modelVersion"`
	Parent         struct {
		GroupId      string `xml:"groupId"`
		ArtifactId   string `xml:"artifactId"`
		Version      string `xml:"version"`
		RelativePath string `xml:"relativePath"`
	} `xml:"parent"`
	ArtifactId string `xml:"artifactId"`
	Name       string `xml:"name"`
	Packaging  string `xml:"packaging"`
	Modules    struct {
		Module []string `xml:"module"`
	} `xml:"modules"`
	Properties struct {
		LiferayBomVersion          string `xml:"liferay.bom.version"`
		LiferayDockerImage         string `xml:"liferay.docker.image"`
		LiferayWorkspaceBundleURL  string `xml:"liferay.workspace.bundle.url"`
		LiferayRepositoryURL       string `xml:"liferay.repository.url"`
		ProjectBuildSourceEncoding string `xml:"project.build.sourceEncoding"`
	} `xml:"properties"`
}

WorkspacePom represents the common structure of a parent Maven pom file in a Liferay Workspace