com.barchart.jenkins.cascade

Class ProjectIdentity

java.lang.Object

hudson.model.JobProperty<hudson.model.AbstractProject<?,?>>

com.barchart.jenkins.cascade.ProjectIdentity

All Implemented Interfaces:

PluginConstants, hudson.ExtensionPoint, hudson.model.Describable<hudson.model.JobProperty<?>>, hudson.model.ReconfigurableDescribable<hudson.model.JobProperty<?>>, hudson.tasks.BuildStep

public class ProjectIdentity
extends hudson.model.JobProperty<hudson.model.AbstractProject<?,?>>
implements PluginConstants

Project identity property for cascade member projects.

Persists role, family id, member id.

Author:

Andrei Pozolotin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectIdentity.Mode Identity equality mode.
static class	ProjectIdentity.TheDescriptor

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static ProjectIdentity.TheDescriptor	META

Fields inherited from class hudson.model.JobProperty

owner

Fields inherited from interface com.barchart.jenkins.cascade.PluginConstants

CASCADE_PROJECT_ICON, CASCADE_PROJECT_NAME, CASCADE_PROJECT_PRONOUN, LAYOUT_ACTION_ICON, LAYOUT_ACTION_NAME, LAYOUT_ACTION_URL, LOGGER_PREFIX, MEMBER_ACTION_ICON, MEMBER_ACTION_NAME, MEMBER_ACTION_URL, MEMBER_GRAPH_NAME, MEMBER_VIEW_ICON, MEMBER_VIEW_NAME, MEMBER_VIEW_URL, PLUGIN_HELP, PLUGIN_ICON, PLUGIN_ID, PLUGIN_IMAGES, PLUGIN_IMAGES_16, PLUGIN_IMAGES_24, PLUGIN_IMAGES_32, PLUGIN_IMAGES_48, PLUGIN_NAME, PLUGIN_URL

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ProjectIdentity(ProjectRole role, String familyID, String projectID)
ProjectIdentity(String projectRole, String familyID, String projectID)

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.model.AbstractProject	abstractProject(ProjectIdentity one, ProjectIdentity.Mode mode) Find project by role and family.
static hudson.model.AbstractProject	abstractProject(ProjectRole role, String familyID, String projectID, ProjectIdentity.Mode mode) Find project.
CascadeProject	cascadeProject() Find cascade project by role, family.
static CascadeProject	cascadeProject(ProjectIdentity identity) Find cascade project by role, family.
static ProjectIdentity	ensureCascadeIdentity(hudson.model.AbstractProject<?,?> layoutProject, hudson.model.AbstractProject<?,?> cascadeProject) Generate unique identity for cascade project.
static ProjectIdentity	ensureLayoutIdentity(hudson.model.AbstractProject<?,?> layoutProject) Generate unique identity for layout project.
static ProjectIdentity	ensureMemberIdentity(hudson.model.AbstractProject<?,?> layoutProject, hudson.model.AbstractProject<?,?> memberProject) Generate unique identity for member project.
boolean	equals(Object other) Equality by role, family id, project id.
boolean	equalsFamily(Object other) Equality by family id.
boolean	equalsRole(Object other) Equality by role.
boolean	equalsRoleFamily(Object other) Equality by role and family.
boolean	equalsRoleFamilyProject(Object other) Equality by role, family, project.
static String	familyID(hudson.model.AbstractProject<?,?> project) Extract family id from the project.
List<hudson.model.AbstractProject>	familyProjectList() Find all cascade family projects.
static List<hudson.model.AbstractProject>	familyProjectList(String familyID) Find all cascade family projects.
hudson.model.ListView	familyView() Find cascade family view.
static hudson.model.ListView	familyView(ProjectIdentity identity) Find cascade family view.
String	familyViewName() Find cascade family view.
static String	familyViewName(ProjectIdentity identity) Find cascade family view.
ProjectIdentity.TheDescriptor	getDescriptor()
String	getFamilyID() Cascade project family id.
Collection<? extends hudson.model.Action>	getJobActions(hudson.model.AbstractProject<?,?> project)
String	getProjectID() ID of a member project.
String	getProjectRole() Project role in the family.
static boolean	hasIdentity(hudson.model.AbstractProject project) Verify a project has this property with all component fields.
static ProjectIdentity	identity(hudson.model.AbstractProject<?,?> project) Extract this property from project.
String	identityRole() Identity by role.
String	identityRoleFamily() Identity by role and family.
String	identityRoleFamilyProject() Identity by role, family, project.
boolean	isValid() Verify all component fields present.
hudson.maven.MavenModuleSet	layoutProject() Find layout project by family.
static hudson.maven.MavenModuleSet	layoutProject(ProjectIdentity identity) Find layout project by role, family.
String	log() Cascade event log.
void	log(String text) Append to cascade event log.
hudson.maven.MavenModuleSet	memberProject() Find member project by family.
hudson.maven.MavenModuleSet	memberProject(hudson.maven.ModuleName moduleName) Find member project with module name.
static hudson.maven.MavenModuleSet	memberProject(ProjectIdentity identity) Find member project by role, family, member.
List<hudson.maven.MavenModuleSet>	memberProjectList() Find member projects in a family.
static List<hudson.maven.MavenModuleSet>	memberProjectList(String familyID) Find member projects by role, family.
ProjectRole	role() Find project role.
String	toString() Render project identity as unique string.

Methods inherited from class hudson.model.JobProperty

getJobAction, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, prebuild, reconfigure, setOwner

Methods inherited from class java.lang.Object

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

Field Detail

META

@Extension
public static final ProjectIdentity.TheDescriptor META

Constructor Detail

ProjectIdentity

public ProjectIdentity(ProjectRole role,
               String familyID,
               String projectID)

ProjectIdentity

@DataBoundConstructor
public ProjectIdentity(String projectRole,
                                    String familyID,
                                    String projectID)

Method Detail

abstractProject

public static hudson.model.AbstractProject abstractProject(ProjectIdentity one,
                                           ProjectIdentity.Mode mode)

Find project by role and family.

abstractProject

public static hudson.model.AbstractProject abstractProject(ProjectRole role,
                                           String familyID,
                                           String projectID,
                                           ProjectIdentity.Mode mode)

Find project.

cascadeProject

public static CascadeProject cascadeProject(ProjectIdentity identity)

Find cascade project by role, family.

ensureCascadeIdentity

public static ProjectIdentity ensureCascadeIdentity(hudson.model.AbstractProject<?,?> layoutProject,
                                    hudson.model.AbstractProject<?,?> cascadeProject)
                                             throws IOException

Generate unique identity for cascade project.

Throws:

IOException

ensureLayoutIdentity

public static ProjectIdentity ensureLayoutIdentity(hudson.model.AbstractProject<?,?> layoutProject)
                                            throws IOException

Generate unique identity for layout project.

Throws:

IOException

ensureMemberIdentity

public static ProjectIdentity ensureMemberIdentity(hudson.model.AbstractProject<?,?> layoutProject,
                                   hudson.model.AbstractProject<?,?> memberProject)
                                            throws IOException

Generate unique identity for member project.

Throws:

IOException

familyID

public static String familyID(hudson.model.AbstractProject<?,?> project)

Extract family id from the project.

familyProjectList

public static List<hudson.model.AbstractProject> familyProjectList(String familyID)

Find all cascade family projects.

familyView

public static hudson.model.ListView familyView(ProjectIdentity identity)

Find cascade family view.

familyViewName

public static String familyViewName(ProjectIdentity identity)

Find cascade family view.

hasIdentity

public static boolean hasIdentity(hudson.model.AbstractProject project)

Verify a project has this property with all component fields.

identity

public static ProjectIdentity identity(hudson.model.AbstractProject<?,?> project)

Extract this property from project.

layoutProject

public static hudson.maven.MavenModuleSet layoutProject(ProjectIdentity identity)

Find layout project by role, family.

memberProject

public static hudson.maven.MavenModuleSet memberProject(ProjectIdentity identity)

Find member project by role, family, member.

memberProjectList

public static List<hudson.maven.MavenModuleSet> memberProjectList(String familyID)

Find member projects by role, family.

cascadeProject

public CascadeProject cascadeProject()

Find cascade project by role, family.

equals

public boolean equals(Object other)

Equality by role, family id, project id.

Overrides:

equals in class Object

equalsFamily

public boolean equalsFamily(Object other)

Equality by family id.

equalsRole

public boolean equalsRole(Object other)

Equality by role.

equalsRoleFamily

public boolean equalsRoleFamily(Object other)

Equality by role and family.

equalsRoleFamilyProject

public boolean equalsRoleFamilyProject(Object other)

Equality by role, family, project.

familyProjectList

public List<hudson.model.AbstractProject> familyProjectList()

Find all cascade family projects.

familyView

public hudson.model.ListView familyView()

Find cascade family view.

familyViewName

public String familyViewName()

Find cascade family view.

getDescriptor

public ProjectIdentity.TheDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.JobProperty<?>>

Overrides:

getDescriptor in class hudson.model.JobProperty<hudson.model.AbstractProject<?,?>>

getFamilyID

public String getFamilyID()

Cascade project family id.

getJobActions

public Collection<? extends hudson.model.Action> getJobActions(hudson.model.AbstractProject<?,?> project)

Overrides:

getJobActions in class hudson.model.JobProperty<hudson.model.AbstractProject<?,?>>

getProjectID

public String getProjectID()

ID of a member project.

getProjectRole

public String getProjectRole()

Project role in the family.

identityRole

public String identityRole()

Identity by role.

identityRoleFamily

public String identityRoleFamily()

Identity by role and family.

identityRoleFamilyProject

public String identityRoleFamilyProject()

Identity by role, family, project.

isValid

public boolean isValid()

Verify all component fields present.

layoutProject

public hudson.maven.MavenModuleSet layoutProject()

Find layout project by family.

log

public String log()

Cascade event log.

log

public void log(String text)

Append to cascade event log.

memberProject

public hudson.maven.MavenModuleSet memberProject()

Find member project by family.

memberProject

public hudson.maven.MavenModuleSet memberProject(hudson.maven.ModuleName moduleName)

Find member project with module name.

memberProjectList

public List<hudson.maven.MavenModuleSet> memberProjectList()

Find member projects in a family.

role

public ProjectRole role()

Find project role.

toString

public String toString()

Render project identity as unique string.

Overrides:

toString in class Object